Accessors
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
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
logLevel
- get logLevel(): LogLevel
-
- set logLevel(val): void
-
Returns void
Methods
addConnectionHandler
- addConnectionHandler(key, handler): void
-
Returns void
addExtension
- addExtension(key, version): void
-
Parameters
-
key: string
-
version: string
Returns void
addFriends
- addFriends(userIds): Promise<User[]>
-
Returns Promise<User[]>
addSendbirdExtensions
- addSendbirdExtensions(sendbirdExtensions, deviceOS, customData?): boolean
-
Parameters
-
-
-
Optional
customData: Record<string, string>
Returns boolean
addUserEventHandler
- addUserEventHandler(key, handler): void
-
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>
-
Returns Promise<void>
buildUserFromSerializedData
- buildUserFromSerializedData(serialized): User
-
clearCachedData
- clearCachedData(): Promise<void>
-
Returns Promise<void>
clearCachedMessages
- clearCachedMessages(channelUrls): Promise<void>
-
Returns Promise<void>
connect
- connect(userId, authToken?): Promise<User>
-
Parameters
-
userId: string
-
Optional
authToken: string
Returns Promise<User>
createApplicationUserListQuery
createBlockedUserListQuery
deleteFriend
- deleteFriend(userId): Promise<void>
-
Returns Promise<void>
deleteFriendDiscoveries
- deleteFriendDiscoveries(discoveryKeys): Promise<void>
-
Returns Promise<void>
deleteFriendDiscovery
- deleteFriendDiscovery(discoveryKey): Promise<void>
-
Returns Promise<void>
deleteFriends
- deleteFriends(userIds): Promise<void>
-
Returns Promise<void>
disconnect
- disconnect(): Promise<void>
-
Returns Promise<void>
disconnectWebSocket
- disconnectWebSocket(): Promise<void>
-
Returns Promise<void>
getAllowFriendDiscovery
- getAllowFriendDiscovery(): Promise<boolean>
-
Returns Promise<boolean>
getCacheDataSize
- getCacheDataSize(): Promise<number>
-
Returns Promise<number>
getChannelInvitationPreference
getEmoji
- getEmoji(emojiKey): Promise<Emoji>
-
Returns Promise<Emoji>
getFriendChangeLogsByToken
getMemoryStoreForDebugging
- getMemoryStoreForDebugging(): null | default
-
Returns null | default
getMyPushTokensByToken
- getMyPushTokensByToken(token, type): Promise<PushTokens>
-
getUIKitConfiguration
- getUIKitConfiguration(): Promise<default>
-
Returns Promise<default>
initializeCache
- initializeCache(userId): Promise<void>
-
Returns Promise<void>
reconnect
- reconnect(): boolean
-
Returns boolean
registerAPNSPushTokenForCurrentUser
registerFCMPushTokenForCurrentUser
removeAllConnectionHandler
- removeAllConnectionHandler(): void
-
Returns void
removeAllUserEventHandler
- removeAllUserEventHandler(): void
-
Returns void
removeConnectionHandler
- removeConnectionHandler(key): void
-
Returns void
removeUserEventHandler
- removeUserEventHandler(key): void
-
Returns void
setAllowFriendDiscovery
- setAllowFriendDiscovery(allowFriendDiscovery): Promise<boolean>
-
Parameters
-
allowFriendDiscovery: boolean
Returns Promise<boolean>
setBackgroundState
- setBackgroundState(): void
-
Returns void
setChannelInvitationPreference
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 = ''
setForegroundState
- setForegroundState(): void
-
Returns void
setOfflineListener
- setOfflineListener(listener): void
-
Returns void
setOnlineListener
- setOnlineListener(listener): void
-
Returns void
setSessionHandler
- setSessionHandler(handler): void
-
Returns void
setSnoozePeriod
- setSnoozePeriod(snoozeOn, startTs?, endTs?): Promise<SnoozePeriod>
-
Parameters
-
snoozeOn: boolean
-
startTs: number = 0
-
endTs: number = 0
unblockUser
- unblockUser(userOrUserId): Promise<void>
-
Parameters
-
userOrUserId: string | User
Returns Promise<void>
unblockUserWithUserId
- unblockUserWithUserId(userId): Promise<void>
-
Returns Promise<void>
unregisterAPNSPushTokenAllForCurrentUser
- unregisterAPNSPushTokenAllForCurrentUser(): Promise<void>
-
Returns Promise<void>
unregisterAPNSPushTokenForCurrentUser
unregisterFCMPushTokenAllForCurrentUser
- unregisterFCMPushTokenAllForCurrentUser(): Promise<void>
-
Returns Promise<void>
unregisterFCMPushTokenForCurrentUser
updateCurrentUserInfo
- updateCurrentUserInfo(params?): Promise<User>
-
Returns Promise<User>
updateCurrentUserInfoWithPreferredLanguages
- updateCurrentUserInfoWithPreferredLanguages(preferredLanguages): Promise<User>
-
Parameters
-
preferredLanguages: string[]
Returns Promise<User>
uploadFriendDiscoveries
- uploadFriendDiscoveries(discoveries): Promise<string>
-
Returns Promise<string>