Class default

Readonly message

Readonly options

Readonly poll

Static instance

• get instance(): default

• Returns default

Static version

• get version(): string

• Returns string

apnsPushToken

• get apnsPushToken(): null | string

• Returns null | string

appId

• get appId(): string

• Returns string

appInfo

• get appInfo(): null | default

• Returns null | default

appVersion

• get appVersion(): string

• Returns string

connectionState

• get connectionState(): ConnectionState

• Returns ConnectionState

currentUser

• get currentUser(): null | User

• Returns null | User

debugMode

• get debugMode(): boolean

• Returns boolean

ekey

• get ekey(): string

• Returns string

fcmPushToken

• get fcmPushToken(): null | string

• Returns null | string

isCacheEnabled

• get isCacheEnabled(): boolean

• Returns boolean

lastConnectedAt

• get lastConnectedAt(): number

• Returns number

localCacheConfig

• get localCacheConfig(): null | LocalCacheConfig

• Returns null | LocalCacheConfig

logLevel

• get logLevel(): LogLevel

• Returns LogLevel

• set logLevel(val): void

• Parameters

  • val: LogLevel

  Returns void

Static init

• init<Modules>(params): default & ModuleNamespaces<[...Modules[], MessageModule, PollModule], [...Modules[], MessageModule, PollModule][number]>

• Type Parameters

  • Modules extends default[]

  Parameters

  • params: SendbirdChatParams<Modules>

  Returns default & ModuleNamespaces<[...Modules[], MessageModule, PollModule], [...Modules[], MessageModule, PollModule][number]>

addConnectionHandler

• addConnectionHandler(key, handler): void

• Parameters

  • key: string

  • handler: ConnectionHandler

  Returns void

addExtension

• addExtension(key, version): void

• Parameters

  • key: string

  • version: string

  Returns void

addFriends

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

• Parameters

  • userIds: string[]

  Returns Promise<User[]>

addSendbirdExtensions

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

• Parameters

  • sendbirdExtensions: SendbirdSdkInfo[]

  • deviceOS: DeviceOsInfo

  • Optional customData: Record<string, string>

  Returns boolean

addUserEventHandler

• addUserEventHandler(key, handler): void

• Parameters

  • key: string

  • handler: UserEventHandler

  Returns void

authenticateFeed

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

• Parameters

  • userId: string

  • Optional authToken: string

  Returns Promise<User>

blockUser

• blockUser(userOrUserId): Promise<void>

• Parameters

  • userOrUserId: string | User

  Returns Promise<void>

blockUserWithUserId

• blockUserWithUserId(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

buildUserFromSerializedData

• buildUserFromSerializedData(serialized): User

• Parameters

  • serialized: object

  Returns User

clearCachedData

• clearCachedData(): Promise<void>

• Returns Promise<void>

clearCachedMessages

• clearCachedMessages(channelUrls): Promise<void>

• Parameters

  • channelUrls: string[]

  Returns Promise<void>

connect

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

• Parameters

  • userId: string

  • Optional authToken: string

  Returns Promise<User>

createApplicationUserListQuery

• createApplicationUserListQuery(params?): ApplicationUserListQuery

• Parameters

  • params: ApplicationUserListQueryParams = {}

  Returns ApplicationUserListQuery

createBlockedUserListQuery

• createBlockedUserListQuery(params?): BlockedUserListQuery

• Parameters

  • params: BlockedUserListQueryParams = {}

  Returns BlockedUserListQuery

createFriendListQuery

• createFriendListQuery(params?): FriendListQuery

• Parameters

  • params: FriendListQueryParams = {}

  Returns FriendListQuery

createMessageSearchQuery

• createMessageSearchQuery(params): MessageSearchQuery

• Parameters

  • params: MessageSearchQueryParams

  Returns MessageSearchQuery

createPollListQuery

• createPollListQuery(params): PollListQuery

• Parameters

  • params: PollListQueryParams

  Returns PollListQuery

createPollVoterListQuery

• createPollVoterListQuery(params): PollVoterListQuery

• Parameters

  • params: PollVoterListQueryParams

  Returns PollVoterListQuery

deleteFriend

• deleteFriend(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

deleteFriendDiscoveries

• deleteFriendDiscoveries(discoveryKeys): Promise<void>

• Parameters

  • discoveryKeys: string[]

  Returns Promise<void>

deleteFriendDiscovery

• deleteFriendDiscovery(discoveryKey): Promise<void>

• Parameters

  • discoveryKey: string

  Returns Promise<void>

deleteFriends

• deleteFriends(userIds): Promise<void>

• Parameters

  • userIds: string[]

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• Returns Promise<void>

disconnectWebSocket

• disconnectWebSocket(): Promise<void>

• Returns Promise<void>

getAllEmoji

• getAllEmoji(): Promise<EmojiContainer>

• Returns Promise<EmojiContainer>

getAllowFriendDiscovery

• getAllowFriendDiscovery(): Promise<boolean>

• Returns Promise<boolean>

getCacheDataSize

• getCacheDataSize(): Promise<number>

• Returns Promise<number>

getChannelInvitationPreference

• getChannelInvitationPreference(): Promise<InvitationPreference>

• Returns Promise<InvitationPreference>

getDoNotDisturb

• getDoNotDisturb(): Promise<DoNotDisturbPreference>

• Returns Promise<DoNotDisturbPreference>

getEmoji

• getEmoji(emojiKey): Promise<Emoji>

• Parameters

  • emojiKey: string

  Returns Promise<Emoji>

getEmojiCategory

• getEmojiCategory(categoryId): Promise<EmojiCategory>

• Parameters

  • categoryId: number

  Returns Promise<EmojiCategory>

getFriendChangeLogsByToken

• getFriendChangeLogsByToken(token): Promise<FriendChangelogs>

• Parameters

  • token: string

  Returns Promise<FriendChangelogs>

getMemoryStoreForDebugging

• getMemoryStoreForDebugging(): null | default

• Returns null | default

getMyPushTokensByToken

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

• Parameters

  • token: string

  • type: PushTokenType

  Returns Promise<PushTokens>

getPushTemplate

• getPushTemplate(): Promise<PushTemplate>

• Returns Promise<PushTemplate>

getPushTriggerOption

• getPushTriggerOption(): Promise<PushTriggerOption>

• Returns Promise<PushTriggerOption>

getSnoozePeriod

• getSnoozePeriod(): Promise<SnoozePeriod>

• Returns Promise<SnoozePeriod>

getUIKitConfiguration

• getUIKitConfiguration(): Promise<default>

• Returns Promise<default>

initializeCache

• initializeCache(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

reconnect

• reconnect(): boolean

• Returns boolean

registerAPNSPushTokenForCurrentUser

• registerAPNSPushTokenForCurrentUser(token): Promise<PushTokenRegistrationState>

• Parameters

  • token: string

  Returns Promise<PushTokenRegistrationState>

registerFCMPushTokenForCurrentUser

• registerFCMPushTokenForCurrentUser(token): Promise<PushTokenRegistrationState>

• Parameters

  • token: string

  Returns Promise<PushTokenRegistrationState>

removeAllConnectionHandler

• removeAllConnectionHandler(): void

• Returns void

removeAllUserEventHandler

• removeAllUserEventHandler(): void

• Returns void

removeConnectionHandler

• removeConnectionHandler(key): void

• Parameters

  • key: string

  Returns void

removeUserEventHandler

• removeUserEventHandler(key): void

• Parameters

  • key: string

  Returns void

setAllowFriendDiscovery

• setAllowFriendDiscovery(allowFriendDiscovery): Promise<boolean>

• Parameters

  • allowFriendDiscovery: boolean

  Returns Promise<boolean>

setBackgroundState

• setBackgroundState(): void

• Returns void

setChannelInvitationPreference

• setChannelInvitationPreference(willAutoAccept): Promise<InvitationPreference>

• Parameters

  • willAutoAccept: boolean

  Returns Promise<InvitationPreference>

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>

setForegroundState

• setForegroundState(): void

• Returns void

setOfflineListener

• setOfflineListener(listener): void

• Parameters

  • listener: OnlineDetectorListener

  Returns void

setOnlineListener

• setOnlineListener(listener): void

• Parameters

  • listener: OnlineDetectorListener

  Returns void

setPushTemplate

• setPushTemplate(templateName): Promise<PushTemplate>

• Parameters

  • templateName: PushTemplate

  Returns Promise<PushTemplate>

setPushTriggerOption

• setPushTriggerOption(pushTriggerOption): Promise<PushTriggerOption>

• Parameters

  • pushTriggerOption: PushTriggerOption

  Returns Promise<PushTriggerOption>

setSessionHandler

• setSessionHandler(handler): void

• Parameters

  • handler: SessionHandler

  Returns void

setSnoozePeriod

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

• Parameters

  • snoozeOn: boolean

  • startTs: number = 0

  • endTs: number = 0

  Returns Promise<SnoozePeriod>

unblockUser

• unblockUser(userOrUserId): Promise<void>

• Parameters

  • userOrUserId: string | User

  Returns Promise<void>

unblockUserWithUserId

• unblockUserWithUserId(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

unregisterAPNSPushTokenAllForCurrentUser

• unregisterAPNSPushTokenAllForCurrentUser(): Promise<void>

• Returns Promise<void>

unregisterAPNSPushTokenForCurrentUser

• unregisterAPNSPushTokenForCurrentUser(token): Promise<PushTokenRegistrationState>

• Parameters

  • token: string

  Returns Promise<PushTokenRegistrationState>

unregisterFCMPushTokenAllForCurrentUser

• unregisterFCMPushTokenAllForCurrentUser(): Promise<void>

• Returns Promise<void>

unregisterFCMPushTokenForCurrentUser

• unregisterFCMPushTokenForCurrentUser(token): Promise<PushTokenRegistrationState>

• Parameters

  • token: string

  Returns Promise<PushTokenRegistrationState>

updateCurrentUserInfo

• updateCurrentUserInfo(params?): Promise<User>

• Parameters

  • params: UserUpdateParams = {}

  Returns Promise<User>

updateCurrentUserInfoWithPreferredLanguages

• updateCurrentUserInfoWithPreferredLanguages(preferredLanguages): Promise<User>

• Parameters

  • preferredLanguages: string[]

  Returns Promise<User>

uploadFriendDiscoveries

• uploadFriendDiscoveries(discoveries): Promise<string>

• Parameters

  • discoveries: FriendDiscovery[]

  Returns Promise<string>