build.gradle
google-services
plugin dependency in top-level gradle filegoogle-services
plugin to app gradle fileAndroidManifest.xml
of the SDK includes the following permission requests. No developer action is required here.App.js
.
app-id
is a unique key associated with your Castled account. It can be found in the Castled dashboard at Settings > Api Keys.location
is the region where you have your Castled account.user-id
is the id that you use internally within your organisation to identify a user.
setUserId
to mitigate any risk of user impersonation. In the absence of a
user-token, no additional verifications will be done to enforce user
authenticity. If your user-id is random id such as a UUID, user-token
is probably not required. More info on user-token can be found in the next
section.user-token
is a unique token per user generated by your app server. This token is usually issued by the app server as a part of user login flow.
user-token
is a Base64 encoded Hash-based Message Authentication Code (HMAC). Ensure the hash computation happens in your app server so that api-key
is not exposed. You can create an api-key
in the Setting > API Keys page within your Castled account. Contact Castled support for help with integration.
Find sample server code snippets to generate HMAC for the user-id
.
CastledConfigs
class of the SDK.
Use these configs if you want to enable specific messsaging channel or want to override default behavior.
Config Name | Description | Default Value |
---|---|---|
enablePush | Enables push notification feature | false |
enablePushBoost | Enhances push notification delivery rates on Android devices with the advanced push boost feature | false |
enableInApp | Enables In App notification feature | false |
enableAppInbox | Enables App Inbox notification feature | false |
enableTracking | Enables tracking of User attributes or App events | false |
enableSessionTracking | Enables tracking of User Sessions | true |
location | Preferred server location | US |
skipUrlHandling | Disables the click action handling by the SDK. Set when app handles the notification action itself | false |
enablePushBoost
to work as expected. For any inquiries or further
assistance, please contact our support team.