Readonly
messageReadonly
optionsReadonly
pollStatic
instanceStatic
versionCurrent SDK version.
Current APNS push token given to registerAPNSPushTokenForCurrentUser().
Current application ID.
The customer app version to log by the app version.
Gets the SDK socket connection state.
Debug mode: showing console logs, using memory database, etc.
The key to authenticate the url retrieved from FileMessage.plainUrl, User.plainProfileImageUrl and Thumbnail.plainUrl. This key has to be put into the HTTP header to access the url provided by above methods.
Current FCM push token given to registerFCMPushTokenForCurrentUser().
Whether the app uses local caching.
The last connected timestamp.
Local cache configuration.
Static
initSendbirdChatWith
Initializes SendbirdChat with given SendbirdChatParams.
Adds a connection handler. All added handlers will be notified when events occurs.
Optional
customData: Record<string, string>Internal purpose. DO NOT USE it for customers.
Adds a user event handler. All added handlers will be notified when events occur.
Blocks the specified User. Blocked User cannot send messages to the blocker.
Creates a query instance to get the whole User list.
Creates a query instance to get only the blocked User (by me) list.
Creates a query instance to get friends.
Creates a query instance to search for a message.
Creates a query instance to get the poll list from the channel.
Creates a query instance to get the voters of a poll option.
Requests the all emoji.
Gets the current User's preference for GroupChannel join. If this is set as true, the User will automatically join the GroupChannel. If set as false, the User can join the GroupChannel by calling GroupChannel.acceptInvitation() or decline the invitation by calling GroupChannel.declineInvitation().
Gets Do-not-disturb option for the current User.
Requests the emoji category.
A pagination token
Gets friend changelogs by token.
A pagination token.
Gets all the push tokens registered to this User.
Gets push template option for the current User. For details of push template option, refer to setPushTemplate. This can be used, for instance, when you need to check the push notification content preview is on or off at the moment.
Gets the current User's push trigger option. Refer to PushTriggerOption. For details of push trigger option, refer to setPushTriggerOption.
Gets snooze period for the current User.
Mark push notification as delivered for push delivery tracking purpose only.
This does not mark the message as delivered.
Marking the message as delivered can be done by [GroupChannelModule.markAsDelivered].
The payload data from the push notification.
Only for Android, the POST_NOTIFICATIONS permission.
Tries reconnection with previously and successfully connected user information. This can be called in ConnectionHandler.onReconnectFailed or where you check the device network status to let the SDK try reconnection. ConnectionHandler.onReconnectStarted will be called after you call this (note that it will not be called if there is previously started connection process which has not finished), and ConnectionHandler.onReconnectFailed or ConnectionHandler.onReconnectSucceeded will be called according to the connection status afterwards.
Usually, the SDK automatically retries connection process when the network connection is lost with some backoff period. When you call this method, you can start connection process immediately.
Optional
details: PushTokenRegistrationDetailsRegisters an APNS push token to the server.
Optional
details: PushTokenRegistrationDetailsRegisters an FCM push token to the server.
Sets the current User's preference for GroupChannel join. If this is set as true, the User will automatically join the GroupChannel. If set as false, the User can join the GroupChannel by calling GroupChannel.acceptInvitation() or decline the invitation by calling GroupChannel.declineInvitation().
Sets Do-not-disturb option for the current User. If this option is enabled, the current User does not receive push notification during the specified time repeatedly. If you want to snooze specific period, use setSnoozePeriod.
Sets custom offline status detection handler.
Sets custom online status detection handler.
Sets push template option for the current User. The only valid arguments for template name are PUSH_TEMPLATE_DEFAULT and PUSH_TEMPLATE_ALTERNATIVE. If PUSH_TEMPLATE_DEFAULT is set, the push notification will contain the original message in the message field of the push notification. If PUSH_TEMPLATE_ALTERNATIVE is set, message of push notification will be replaced by the content you've set on SendbirdChat Dashboard.
Sets the current User's push trigger option. If certain channel's push trigger option is set to GroupChannel.PushTriggerOption.DEFAULT, it works according to the state of PushTriggerOption. If not, push messages will be triggered according to the state of GroupChannel.PushTriggerOption. Refer to GroupChannel.PushTriggerOption.
Set a SessionHandler which is required for SDK refresh the session when the current session expires.
Sets snooze period for the current User. If this option is enabled, the current User does not receive push notification during the given period. It's not a repetitive operation. If you want to snooze repeatedly, use setDoNotDisturb.
Unblocks the specified User. Unblocked User can send messages to the ex-blocker.
Deregisters an APNS token from the server.
Deregisters an FCM token from the server.
Updates current User's information.
A friend discovery request ID.
Uploads friend discoveries.
Generated using TypeDoc
Represents operation options.