Setup & Authentication

With Amity UIKit SDK 4.1, we have introduce a new way to Authentication process. Please follow the guide below

Setup API Key

UIKit requires an API key, you will need a valid API key to begin using the UIKit.

UpstraUIKit.setup(apiKey: "YOUR_API_KEY")

Authentication

To use any SDK feature, you must first register the current device with an userId. A device registered with an userId will be permanently tied to that userId until you explicitly unregister the device, or until the device has been inactive for more than 90 days. A device registered with a specific userId will receive all messages belonging to that user.

Additionally, an optional displayName can be provided if you wish to have this user identified in push notifications.

UpstraUIKit.registerDevice(withUserId: "USER_ID", displayName: "Ali Connors", authToken: "AUTH_TOKEN")

Unregister

In the event that your user logs out, you should explicitly unregister the user from the SDK as well, to prevent the current device from receiving any unnecessary or restricted data.

UpstraUIKit.unregisterDevice()

Last updated