Package-level declarations
Functions
Add friends.
Sets friend discoverability of current user.
If you want to use the interface provided by the FeedChannel only, we'd recommend to authenticate using this function instead of SendbirdChat.awaitConnect.
If you want to use the interface provided by the FeedChannel only, we'd recommend to authenticate using this function instead of SendbirdChat.awaitConnect.
Add friends.
Sets friend discoverability of current user.
Authenticates to SendbirdChat with given User ID and auth token. This method is different from SendbirdChat.awaitConnect in that it doesn't create a websocket connection. This should be used in below cases: 1. If you want to use the interface provided by the FeedChannel only. 2. If you want to use chat interface prior to SendbirdChat.connect, i.e. SendbirdChat.getTotalUnreadMessageCount.
Blocks the specified User. Blocked User cannot send messages to the blocker.
Clears the db data used in local caching. If local caching is enabled, this should be called before SendbirdChat.initFlow.
Clear cached messages of specific channel.
Connects to SendbirdChat with given User ID and auth token. If you have created Users without auth token, pass authToken with null.
Delete friend.
Delete friend discoveries.
Delete friend discovery.
Delete friends.
Disconnects from SendbirdChat.
Disconnects the websocket connection only. This does not clear the currentUser and any cached data. If you want to logout, call awaitDisconnect.
Requests the all emoji. The result is passed to handler.
Gets friend discoverability of current user.
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. The result is passed to handler.
Requests the emoji category. The result is passed to handler.
Get friend changelogs by token.
Retrieves Global Notification channel theme.
Gets the number of my GroupChannels.
Requests the changelogs of members of group channels the current user is joined in.
Requests the changelogs of members of group channels the current user is joined in.
Retrieves a single message template by given template key.
Retrieves Message template list by token
Requests the channel changelogs after given timestamp. The result is passed to handler.
Requests the channel changelogs from given token. The result is passed to handler.
Requests the channel changelogs after given timestamp. The result is passed to handler.
Requests the channel changelogs from given token. The result is passed to handler.
Requests push tokens of current user from given token. The result is passed to handler.
Retrieves Notification template
Retrieves Notification template list by token
Gets push notification sound path for the current User.
Gets push template option for the current User. For details of push template option, refer to awaitSetPushTemplate. 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 awaitSetPushTriggerOption.
Get the list of report categories.
Gets snooze period for the current User.
Gets the number of total scheduled messages.
Gets the total number of unread GroupChannels the current user has joined.
Gets the total number of unread message of GroupChannels with GroupChannelTotalUnreadMessageCountParams filter.
Gets the total number of unread notifications of FeedChannel
Gets the unread item count of GroupChannels corresponding to GroupChannelUnreadItemCountParams.
Gets the unread item count of GroupChannels from keys.
Sends mark as delivered to this channel when you received push message from us.
Sends mark as read to joined GroupChannels. This method has rate limit. You can send one request per second. It returns SendbirdException if you exceed the rate limit.
Sends mark as read to all joined GroupChannels. This method has rate limit. You can send one request per second. It returns SendbirdException if you exceed the rate limit.
Registers push token for the current User to receive push notification. To enable push notification and get a token, refer to Sendbird Docs.
Push token registration succeeds only when the connection (awaitConnect) is made. Otherwise, callback will return with PushTokenRegistrationStatus.PENDING status. Then you can register push token again by calling this method with pushToken which is provided by FCM as the token parameter, after the connection is done. This just adds token to the server. If you want to register this token and delete all the previous ones, refer to awaitRegisterPushToken.
Registers push token for the current User to receive push notification. To enable push notification and get a token, refer to Sendbird Docs.
Push token registration succeeds only when the connection (awaitConnect) is made. Otherwise, callback will return with PushTokenRegistrationStatus.PENDING status. Then you can register push token again by calling this method with pushToken which is provided by HMS as the token parameter, after the connection is done.
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 awaitSetSnoozePeriod.
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 SendbirdChat.HMS.awaitSetSnoozePeriod.
Sets the push notification sound file path for the current User. This setting will be delivered on push notification payload.
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 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 Sendbird 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.
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 awaitSetDoNotDisturb.
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 awaitSetSnoozePeriod.
Unblocks the specified User. Unblocked User can send messages to the ex-blocker.
Unregisters push token for the current User.
Unregisters all push token bound to the current User.
Updates current User's information.
Updates current User's preferred language.
Upload friend discoveries. SendbirdChat.addUserEventHandler SendbirdChat.removeAllUserEventHandlers
Blocks the specified User. Blocked User cannot send messages to the blocker.
Blocks the specified User ID. Blocked User cannot send messages to the blocker.
Clears the db data used in local caching. If local caching is enabled, this should be called before SendbirdChat.initFlow.
Clear cached messages of specific channel.
Connects to SendbirdChat with given User ID and auth token. If you have created Users without auth token, pass authToken with null.
Delete friend.
Delete friend discoveries.
Delete friend discovery.
Delete friends.
Disconnects from SendbirdChat.
Disconnects the websocket connection only. This does not clear the currentUser and any cached data. If you want to logout, call awaitDisconnect.
Requests the all emoji. The result is passed to handler.
Gets friend discoverability of current user.
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. The result is passed to handler.
Get friend changelogs by token.
Retrieves Global Notification channel theme.
Gets the number of my GroupChannels.
Requests the changelogs of members of group channels the current user is joined in.
Requests the changelogs of members of group channels the current user is joined in.
Retrieves a single message template by given template key.
Retrieves Message template list by token
Requests the channel changelogs after given timestamp. The result is passed to handler.
Requests the channel changelogs from given token. The result is passed to handler.
Requests the channel changelogs after given timestamp. The result is passed to handler.
Requests the channel changelogs from given token. The result is passed to handler.
Requests push tokens of current user from given token. The result is passed to handler.
Retrieves Notification template
Retrieves Notification template list by token
Gets push notification sound path for the current User.
Gets push template option for the current User. For details of push template option, refer to awaitSetPushTemplate. 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 awaitSetPushTriggerOption.
Get the list of report categories.
Gets snooze period for the current User.
Gets the number of total scheduled messages.
Gets the total number of unread GroupChannels the current user has joined.
Gets the total number of unread message of GroupChannels with GroupChannelTotalUnreadMessageCountParams filter.
Gets the total number of unread notifications of FeedChannel
Gets the unread item count of GroupChannels from keys.
Gets the unread item count of GroupChannels corresponding to GroupChannelUnreadItemCountParams.
Initializes SendbirdChat with given InitParams.
Initializes SendbirdChat with given InitParams.
Sends mark as delivered to this channel when you received push message from us.
Sends mark as read to joined GroupChannels. This method has rate limit. You can send one request per second. It returns SendbirdException if you exceed the rate limit.
Sends mark as read to all joined GroupChannels. This method has rate limit. You can send one request per second. It returns SendbirdException if you exceed the rate limit.
Registers push token for the current User to receive push notification. To enable push notification and get a token, refer to Sendbird Docs.
Push token registration succeeds only when the connection (awaitConnect) is made. Otherwise, callback will return with PushTokenRegistrationStatus.PENDING status. Then you can register push token again by calling this method with pushToken which is provided by FCM as the token parameter, after the connection is done. This just adds token to the server. If you want to register this token and delete all the previous ones, refer to awaitRegisterPushToken.
Registers push token for the current User to receive push notification. To enable push notification and get a token, refer to Sendbird Docs.
Push token registration succeeds only when the connection (awaitConnect) is made. Otherwise, callback will return with PushTokenRegistrationStatus.PENDING status. Then you can register push token again by calling this method with pushToken which is provided by HMS as the token parameter, after the connection is done.
Registers push token for the current User to receive push notification. To enable push notification and get a token, refer to Sendbird Docs.
Push token registration succeeds only when the connection (awaitConnect) is made. Otherwise, callback will return with PushTokenRegistrationStatus.PENDING status. Then, you can register push token again by calling awaitRegisterPushToken after the connection is done.
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 awaitSetSnoozePeriod.
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 SendbirdChat.HMS.awaitSetSnoozePeriod.
Sets the push notification sound file path for the current User. This setting will be delivered on push notification payload.
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 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 Sendbird 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.
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 awaitSetSnoozePeriod.
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 SendbirdChat.HMS.awaitSetSnoozePeriod.
Unblocks the specified User. Unblocked User can send messages to the ex-blocker.
Unregisters push token for the current User.
Unregisters all push token bound to the current User.
Updates current User's information.
Updates current User's preferred language.
Upload friend discoveries. SendbirdChat.addUserEventHandler SendbirdChat.removeAllUserEventHandlers