Class default

Readonly message

Readonly options

Readonly poll

Static instance

• get instance(): default

• Returns default

  Description

  An active SendbirdChat instance.

Static version

• get version(): string

• Returns string

  Description

  Current SDK version.

apnsPushToken

• get apnsPushToken(): null | string

• Returns null | string

  Description

  Current APNS push token given to registerAPNSPushTokenForCurrentUser().

appId

• get appId(): string

• Returns string

  Description

  Current application ID.

appInfo

• get appInfo(): null | AppInfo

• Returns null | AppInfo

  Description

  Represents information obtained from the application settings.

appVersion

• get appVersion(): string

• Returns string

  Description

  The customer app version to log by the app version.

connectionState

• get connectionState(): ConnectionState

• Returns ConnectionState

  Description

  Gets the SDK socket connection state.

currentUser

• get currentUser(): null | User

• Returns null | User

  Description

  The current connected User. null if connect is not called.

debugMode

• get debugMode(): boolean

• Returns boolean

  Description

  Debug mode: showing console logs, using memory database, etc.

ekey

• get ekey(): string

• Returns string

  Description

  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.

fcmPushToken

• get fcmPushToken(): null | string

• Returns null | string

  Description

  Current FCM push token given to registerFCMPushTokenForCurrentUser().

isCacheEnabled

• get isCacheEnabled(): boolean

• Returns boolean

  Description

  Whether the app uses local caching.

lastConnectedAt

• get lastConnectedAt(): number

• Returns number

  Description

  The last connected timestamp.

localCacheConfig

• get localCacheConfig(): null | LocalCacheConfig

• Returns null | LocalCacheConfig

  Description

  Local cache configuration.

logLevel

• get logLevel(): LogLevel

• Returns LogLevel

  Description

  LogLevel for Sendbird.

• set logLevel(val): void

• Parameters

  • val: LogLevel

  Returns void

Static init

• init<Modules>(params): SendbirdChatWith<Modules>

• Type Parameters

  • Modules extends default[]

  Parameters

  • params: SendbirdChatParams<Modules>

  Returns SendbirdChatWith<Modules>

  SendbirdChatWith

  Description

  Initializes SendbirdChat with given SendbirdChatParams.

addConnectionHandler

• addConnectionHandler(key, handler): void

• Parameters

  • key: string

  • handler: ConnectionHandler

  Returns void

  Description

  Adds a connection handler. All added handlers will be notified when events occurs.

addExtension

• addExtension(key, version): void

• Parameters

  • key: string

  • version: string

  Returns void

  Description

  To send additional User-Agent information please set the version information. This will be set pre-defined keys only.

addFriends

• addFriends(userIds): Promise<User[]>

• Parameters

  • userIds: string[]

  Returns Promise<User[]>

  Description

  Add friends.

addSendbirdExtensions

• addSendbirdExtensions(sendbirdExtensions, deviceOS, customData?): boolean

• Parameters

  • sendbirdExtensions: SendbirdSdkInfo[]

  • deviceOS: DeviceOsInfo

  • Optional customData: Record<string, string>

  Returns boolean

  Description

  Internal purpose. DO NOT USE it for customers.

addUserEventHandler

• addUserEventHandler(key, handler): void

• Parameters

  • key: string

  • handler: UserEventHandler

  Returns void

  Description

  Adds a user event handler. All added handlers will be notified when events occur.

authenticateFeed

• authenticateFeed(userId, authToken?): Promise<User>

• Parameters

  • userId: string

  • Optional authToken: string

  Returns Promise<User>

  Description

  If you want to use the interface provided by the FeedChannel only, we'd recommend to authenticate using this function instead of SendbirdChat.connect.

blockUser

• blockUser(userOrUserId): Promise<void>

• Parameters

  • userOrUserId: string | User

  Returns Promise<void>

  Description

  Blocks the specified User. Blocked User cannot send messages to the blocker.

blockUserWithUserId

• blockUserWithUserId(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

  Description

  Blocks the specified User with userId. Blocked User cannot send messages to the blocker.

buildUserFromSerializedData

• buildUserFromSerializedData(serialized): User

• Parameters

  • serialized: object

  Returns User

  Description

  Makes a User from User-serialized object.

clearCachedData

• clearCachedData(): Promise<void>

• Returns Promise<void>

  Description

  Clears the database used for local caching.

clearCachedMessages

• clearCachedMessages(channelUrls): Promise<void>

• Parameters

  • channelUrls: string[]

  Returns Promise<void>

  Description

  Clears cached messages of specific channel.

connect

• connect(userId, authToken?): Promise<User>

• Parameters

  • userId: string

  • Optional authToken: string

  Returns Promise<User>

  Description

  Connects to SendbirdChat with given User ID and auth token. If you have created Users without auth token, you could ignore authToken.

createApplicationUserListQuery

• createApplicationUserListQuery(params?): ApplicationUserListQuery

• Parameters

  • params: ApplicationUserListQueryParams = {}

  Returns ApplicationUserListQuery

  Description

  Creates a query instance to get the whole User list.

createBlockedUserListQuery

• createBlockedUserListQuery(params?): BlockedUserListQuery

• Parameters

  • params: BlockedUserListQueryParams = {}

  Returns BlockedUserListQuery

  Description

  Creates a query instance to get only the blocked User (by me) list.

createFriendListQuery

• createFriendListQuery(params?): FriendListQuery

• Parameters

  • params: FriendListQueryParams = {}

  Returns FriendListQuery

  Description

  Creates a query instance to get friends.

createMessageSearchQuery

• createMessageSearchQuery(params): MessageSearchQuery

• Parameters

  • params: MessageSearchQueryParams

  Returns MessageSearchQuery

  Description

  Creates a query instance to search for a message.

createPollListQuery

• createPollListQuery(params): PollListQuery

• Parameters

  • params: PollListQueryParams

  Returns PollListQuery

  Description

  Creates a query instance to get the poll list from the channel.

createPollVoterListQuery

• createPollVoterListQuery(params): PollVoterListQuery

• Parameters

  • params: PollVoterListQueryParams

  Returns PollVoterListQuery

  Description

  Creates a query instance to get the voters of a poll option.

deleteFriend

• deleteFriend(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

  Description

  Deletes a friend.

deleteFriendDiscoveries

• deleteFriendDiscoveries(discoveryKeys): Promise<void>

• Parameters

  • discoveryKeys: string[]

  Returns Promise<void>

  Description

  Deletes friend discoveries.

deleteFriendDiscovery

• deleteFriendDiscovery(discoveryKey): Promise<void>

• Parameters

  • discoveryKey: string

  Returns Promise<void>

  Description

  Deletes friend discovery.

deleteFriends

• deleteFriends(userIds): Promise<void>

• Parameters

  • userIds: string[]

  Returns Promise<void>

  Description

  Deletes friends.

disconnect

• disconnect(): Promise<void>

• Returns Promise<void>

  Description

  Disconnects from SendbirdChat.

disconnectWebSocket

• disconnectWebSocket(): Promise<void>

• Returns Promise<void>

  Description

  Disconnects the WebSocket connection only. It does not clear the currentUser and cached data. If you want to logout, call disconnect.

getAllEmoji

• getAllEmoji(): Promise<EmojiContainer>

• Returns Promise<EmojiContainer>

  Description

  Requests the all emoji.

getAllowFriendDiscovery

• getAllowFriendDiscovery(): Promise<boolean>

• Returns Promise<boolean>

  Description

  Gets friend discoverability of current user.

getCacheDataSize

• getCacheDataSize(): Promise<number>

• Returns Promise<number>

  Description

  Gets the size of cached data. Returns 0 if local cache is disabled.

getChannelInvitationPreference

• getChannelInvitationPreference(): Promise<InvitationPreference>

• Returns Promise<InvitationPreference>

  Description

  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().

getDoNotDisturb

• getDoNotDisturb(): Promise<DoNotDisturbPreference>

• Returns Promise<DoNotDisturbPreference>

  Description

  Gets Do-not-disturb option for the current User.

getEmoji

• getEmoji(emojiKey): Promise<Emoji>

• Parameters

  • emojiKey: string

  Returns Promise<Emoji>

  Description

  Requests the emoji.

getEmojiCategory

• getEmojiCategory(categoryId): Promise<EmojiCategory>

• Parameters

  • categoryId: number

  Returns Promise<EmojiCategory>

  Description

  Requests the emoji category.

getFriendChangeLogsByToken

• getFriendChangeLogsByToken(token): Promise<FriendChangelogs>

• Parameters

  • token: string

    A pagination token

  Returns Promise<FriendChangelogs>

  Description

  Gets friend changelogs by token.

getMemoryStoreForDebugging

• getMemoryStoreForDebugging(): null | default

• Returns null | default

  MemoryStore

  Description

  (Debug mode only) Get the raw data store.

getMyPushTokensByToken

• getMyPushTokensByToken(token, type): Promise<PushTokens>

• Parameters

  • token: string

    A pagination token.

  • type: PushTokenType

  Returns Promise<PushTokens>

  Description

  Gets all the push tokens registered to this User.

getPushTemplate

• getPushTemplate(): Promise<PushTemplate>

• Returns Promise<PushTemplate>

  Description

  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.

getPushTriggerOption

• getPushTriggerOption(): Promise<PushTriggerOption>

• Returns Promise<PushTriggerOption>

  Description

  Gets the current User's push trigger option. Refer to PushTriggerOption. For details of push trigger option, refer to setPushTriggerOption.

getSnoozePeriod

• getSnoozePeriod(): Promise<SnoozePeriod>

• Returns Promise<SnoozePeriod>

  Description

  Gets snooze period for the current User.

initializeCache

• initializeCache(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

  Description

  Initializes local cache database.

markPushNotificationAsClicked

• markPushNotificationAsClicked(pushData): Promise<void>

• Mark push notification as clicked for push delivery tracking purpose only.

  Parameters

  • pushData: Record<string, unknown>

    The payload data from the push notification.

  Returns Promise<void>

markPushNotificationAsDelivered

• markPushNotificationAsDelivered(pushData, allowedPushNotification?): Promise<void>

• 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].

  Parameters

  • pushData: Record<string, unknown>

    The payload data from the push notification.

  • allowedPushNotification: boolean = true

    Only for Android, the POST_NOTIFICATIONS permission.

  Returns Promise<void>

reconnect

• reconnect(): boolean

• Returns boolean

  Description

  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.

registerAPNSPushTokenForCurrentUser

• registerAPNSPushTokenForCurrentUser(token, details?): Promise<PushTokenRegistrationState>

• Parameters

  • token: string

  • Optional details: PushTokenRegistrationDetails

  Returns Promise<PushTokenRegistrationState>

  Description

  Registers an APNS push token to the server.

registerFCMPushTokenForCurrentUser

• registerFCMPushTokenForCurrentUser(token, details?): Promise<PushTokenRegistrationState>

• Parameters

  • token: string

  • Optional details: PushTokenRegistrationDetails

  Returns Promise<PushTokenRegistrationState>

  Description

  Registers an FCM push token to the server.

removeAllConnectionHandler

• removeAllConnectionHandler(): void

• Returns void

  Description

  Removes all connection handlers added by addConnectionHandler.

removeAllUserEventHandler

• removeAllUserEventHandler(): void

• Returns void

  Description

  Removes all user event handlers added by addUserEventHandler.

removeConnectionHandler

• removeConnectionHandler(key): void

• Parameters

  • key: string

  Returns void

  Description

  Removes a connection handler for the key. The deleted handler no longer be notified.

removeUserEventHandler

• removeUserEventHandler(key): void

• Parameters

  • key: string

  Returns void

  Description

  Removes a user event handler for the key. The deleted handler no longer be notified.

setAllowFriendDiscovery

• setAllowFriendDiscovery(allowFriendDiscovery): Promise<boolean>

• Parameters

  • allowFriendDiscovery: boolean

  Returns Promise<boolean>

  Description

  Sets friend discoverability of current user.

setBackgroundState

• setBackgroundState(): void

• Returns void

  Description

  Sets the SDK as background mode. It closes WebSocket connection but keeps the currentUser and cached data.

setChannelInvitationPreference

• setChannelInvitationPreference(willAutoAccept): Promise<InvitationPreference>

• Parameters

  • willAutoAccept: boolean

  Returns Promise<InvitationPreference>

  Description

  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().

setDoNotDisturb

• setDoNotDisturb(doNotDisturbOn, startHour?, startMin?, endHour?, endMin?, timezone?): Promise<DoNotDisturbPreference>

• Parameters

  • doNotDisturbOn: boolean

  • startHour: number = 0

  • startMin: number = 0

  • endHour: number = 0

  • endMin: number = 0

  • timezone: string = ''

  Returns Promise<DoNotDisturbPreference>

  Description

  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.

setForegroundState

• setForegroundState(): void

• Returns void

  Description

  Recovers the SDK from the background mode. It re-establishes WebSocket connection for the currentUser.

setOfflineListener

• setOfflineListener(listener): void

• Parameters

  • listener: OnlineDetectorListener

  Returns void

  Description

  Sets custom offline status detection handler.

setOnlineListener

• setOnlineListener(listener): void

• Parameters

  • listener: OnlineDetectorListener

  Returns void

  Description

  Sets custom online status detection handler.

setPushTemplate

• setPushTemplate(templateName): Promise<PushTemplate>

• Parameters

  • templateName: PushTemplate

  Returns Promise<PushTemplate>

  Description

  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.

setPushTriggerOption

• setPushTriggerOption(pushTriggerOption): Promise<PushTriggerOption>

• Parameters

  • pushTriggerOption: PushTriggerOption

  Returns Promise<PushTriggerOption>

  Description

  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.

setSessionHandler

• setSessionHandler(handler): void

• Parameters

  • handler: SessionHandler

  Returns void

  Description

  Set a SessionHandler which is required for SDK refresh the session when the current session expires.

setSnoozePeriod

• setSnoozePeriod(snoozeOn, startTs?, endTs?): Promise<SnoozePeriod>

• Parameters

  • snoozeOn: boolean

  • startTs: number = 0

  • endTs: number = 0

  Returns Promise<SnoozePeriod>

  Description

  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.

unblockUser

• unblockUser(userOrUserId): Promise<void>

• Parameters

  • userOrUserId: string | User

  Returns Promise<void>

  Description

  Unblocks the specified User. Unblocked User can send messages to the ex-blocker.

unblockUserWithUserId

• unblockUserWithUserId(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

  Description

  Unblocks the specified User with userId. Unblocked User can send messages to the ex-blocker.

unregisterAPNSPushTokenAllForCurrentUser

• unregisterAPNSPushTokenAllForCurrentUser(): Promise<void>

• Returns Promise<void>

  Description

  Deregister all APNS push tokens for the user.

unregisterAPNSPushTokenForCurrentUser

• unregisterAPNSPushTokenForCurrentUser(token): Promise<PushTokenRegistrationState>

• Parameters

  • token: string

  Returns Promise<PushTokenRegistrationState>

  Description

  Deregisters an APNS token from the server.

unregisterFCMPushTokenAllForCurrentUser

• unregisterFCMPushTokenAllForCurrentUser(): Promise<void>

• Returns Promise<void>

  Description

  Deregister all FCM push tokens for the user.

unregisterFCMPushTokenForCurrentUser

• unregisterFCMPushTokenForCurrentUser(token): Promise<PushTokenRegistrationState>

• Parameters

  • token: string

  Returns Promise<PushTokenRegistrationState>

  Description

  Deregisters an FCM token from the server.

updateCurrentUserInfo

• updateCurrentUserInfo(params?): Promise<User>

• Parameters

  • params: UserUpdateParams = {}

  Returns Promise<User>

  Description

  Updates current User's information.

updateCurrentUserInfoWithPreferredLanguages

• updateCurrentUserInfoWithPreferredLanguages(preferredLanguages): Promise<User>

• Parameters

  • preferredLanguages: string[]

  Returns Promise<User>

  Description

  Updates current User's preferred language.

uploadFriendDiscoveries

• uploadFriendDiscoveries(discoveries): Promise<string>

• Parameters

  • discoveries: FriendDiscovery[]

  Returns Promise<string>

  A friend discovery request ID.

  Description

  Uploads friend discoveries.