CometChatUIKit
is a class that contains all necessary methods to help initialize the CometChat SDK with valid credentials for the ui kit to utilize.
The following properties and methods are present:
Parameters | Type | Description |
---|---|---|
init | static init(uiKitSettings: UIKitSettings): Promise<boolean> | method initializes the settings required for CometChat SDK. First, ensure authSettings is set and then call the init() method on app startup |
login | static async login({ uid, authToken }: { uid?: string, authToken?: string }): Promise<CometChat.User> | used for logging in with credentials but use this function only for testing purpose |
logout | static logout(): Promise<Object> | used for ending user session of logged in user |
createUser | static createUser( user: CometChat.User): Promise<CometChat.User> | used for creating new user |
updateUser | static updateUser(user: CometChat.User): Promise<CometChat.User> { | used for updating user object |
sendCustomMessage | static sendCustomMessage(message: CometChat.CustomMessage, onSuccess?: (msg: CometChat.CustomMessage | CometChat.BaseMessage) => void, onError?: (msg: CometChat.CometChatException) => void): void | can be used to send a custom message |
sendTextMessage | static sendTextMessage(message: CometChat.TextMessage, onSuccess?: (msg: CometChat.TextMessage | CometChat.BaseMessage) => void, onError?: (msg: CometChat.CometChatException) => void): void | can be used to send a text message |
sendMediaMessage | static sendMediaMessage(message: CometChat.CustomMessage, onSuccess?: (msg: CometChat.MediaMessage | CometChat.BaseMessage) => void, onError?: (msg: CometChat.CometChatException) => void): void | can be used to send a media message |
sendFormMessage | static sendFormMessage(message: FormMessage, disableLocalEvents: boolean = false): Promise<CometChat.TextMessage | CometChat.BaseMessage> | can be used to send a form message. disableLocalEvents - A boolean indicating whether to disable local events or not. Default value is false. |
sendCardMessage | static sendCardMessage(message: CardMessage, disableLocalEvents: boolean = false): Promise<CometChat.TextMessage | CometChat.BaseMessage> | can be used to send a card message. disableLocalEvents - A boolean indicating whether to disable local events or not. Default value is false. |
sendCustomInteractiveMessage | static sendCustomInteractiveMessage(message: CustomInteractiveMessage, disableLocalEvents: boolean = false): Promise<CometChat.TextMessage | CometChat.BaseMessage> | can be used to send a custom interactive message. disableLocalEvents - A boolean indicating whether to disable local events or not. Default value is false. |
sendTextMessage
Used to send text messages.sendMediaMessage
used to send media messagessendCustomMessage
Used to send custom messages.Send Form message
This method allows you to send Form messages which are the extension of Interactive MessageSend Card message
This method allows you to send Card messages which are the extension of Interactive MessageSend CustomInteractive message
This method allows you to send CustomInteractive messages which are the extension of Interactive MessageUIKitSettings
UIKitSettings is an object containing credentials to initialize CometChat SDK.Properties | Type | Description |
---|---|---|
appId | string | the unique ID for the app, available on dashboard |
region | string | the region for the app us or eu |
authKey | string | the auth key for the app, available on dashboard |
subscriptionType | string | sets user presence subscription for all users |
autoEstablishSocketConnection | Bool | configure if web socket connections will established automatically on app initialization or be done manually, set to true by default |
disableCalling | boolean | disable calling |
overrideAdminHost | string | used to set the admin host |
overrideClientHost | string | used to set the client host |
How to initialize the UI Kit?
The UI Kit can be initialized to use CometChatUIKit by populating the auth settings first and the calling the init method. Preferably this should be done at the top most level when the app starts.Make sure you replace the APP_ID, REGION and AUTH_KEY with your CometChat App ID, Region and Auth Key in the below code. The
Auth Key
is an optional property of the UIKitSettings
Class. It is intended for use primarily during proof-of-concept (POC) development or in the early stages of application development. You can use the Auth Token method to log in securely.How to login a user of your App?
Only theUID
of a user is needed to log in. This simple authentication procedure is useful when you are creating a POC or if you are in the development phase. For production apps, we suggest you use AuthToken instead of Auth Key.
How to login a user with Auth Token?
This advanced authentication procedure does not use the Auth Key directly in your client code thus ensuring safety.- Create a User via the CometChat API when the user signs up in your app.
- Create an Auth Token via the CometChat API for the new user and save the token in your database.
- Load the Auth Token in your client and pass it to the
login({authToken: authToken})
method.
How to create a new user for your App?
Create an object the new user that needs to created with as little information as the name of the user and a uid and pass it to the create(user: User) methodHow to update a user for your App?
Update an object the user that needs to updated with as little information as the name of the user and a uid and pass it to theupdate(user: User)
method