Constructors
constructor
- new IMClient(_context: APIContext, _options: IIMClientOptions): IMClient
Parameters
_context: APIContext
_options: IIMClientOptions
Methods
RTCPing
- RTCPing(room: RTCRoomOption, callback: ICallback<boolean, void>): void
Parameters
room: RTCRoomOption
callback: ICallback<boolean, void>
Returns void
addTagForConversations
- addTagForConversations(tagId: string, conversations: IConversationOption[], callback: ICallback<void, void>): void
Parameters
tagId: string
conversations: IConversationOption[]
callback: ICallback<void, void>
Returns void
addToBlacklist
- addToBlacklist(userId: string, callback: ICallback<void, void>): void
Parameters
userId: string
callback: ICallback<void, void>
Returns void
callExtra
- callExtra(method: string, callback: ICallback<unknown, unknown>, ...args: any[]): void
Parameters
method: string
callback: ICallback<unknown, unknown>
Rest ...args: any[]
Returns void
clearCache
Returns void
clearConversations
- clearConversations(callback: ICallback<boolean, void>, conversationTypes: ConversationType[]): void
Parameters
callback: ICallback<boolean, void>
Returns void
clearMessages
- clearMessages(conversationType: ConversationType, targetId: string, callback: ICallback<boolean, void>): void
Parameters
targetId: string
callback: ICallback<boolean, void>
Returns void
clearRemoteHistoryMessages
- clearRemoteHistoryMessages(param: IDelteByTime, callback: ICallback<void, void>): void
Parameters
param: IDelteByTime
callback: ICallback<void, void>
Returns void
clearTextMessageDraft
- clearTextMessageDraft(conversationType: ConversationType, targetId: string): boolean
Parameters
Returns boolean
clearUnreadCount
- clearUnreadCount(conversationType: ConversationType, targetId: string, callback: ICallback<boolean, void>): void
Parameters
targetId: string
callback: ICallback<boolean, void>
Returns void
clearUnreadCountByTimestamp
- clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, callback: ICallback<boolean, void>): void
Parameters
targetId: string
timestamp: number
callback: ICallback<boolean, void>
Returns void
createTag
- createTag(tag: ITagParam, callback: ICallback<void, void>): void
Parameters
tag: ITagParam
callback: ICallback<void, void>
Returns void
deleteChannels
- deleteChannels(channelIds: string[]): void
Parameters
Returns void
deleteLocalMessages
- deleteLocalMessages(_: ConversationType, __: string, messageIds: number[], callback: ICallback<boolean, void>): void
Parameters
__: string
messageIds: number[]
callback: ICallback<boolean, void>
Returns void
deleteLocalMessagesByTimestamp
- deleteLocalMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, callback: ICallback<boolean, void>): void
Parameters
targetId: string
timestamp: number
cleanSpace: boolean
callback: ICallback<boolean, void>
Returns void
deleteRemoteMessages
- deleteRemoteMessages(conversationType: ConversationType, targetId: string, messages: IDeleteMessge[], callback: ICallback<void, void>): void
Parameters
targetId: string
messages: IDeleteMessge[]
callback: ICallback<void, void>
Returns void
disconnect
- disconnect(): Promise<void>
Returns Promise<void>
forceRemoveChatroomEntry
- forceRemoveChatroomEntry(chatRoomId: string, chatroomEntry: IRemoveChatRoomEntryOption, callback: ICallback<void, void>): void
Parameters
chatRoomId: string
chatroomEntry: IRemoveChatRoomEntryOption
callback: ICallback<void, void>
Returns void
forceSetChatroomEntry
- forceSetChatroomEntry(chatRoomId: string, chatroomEntry: IChatroomEntry, callback: ICallback<void, void>): void
Parameters
chatRoomId: string
chatroomEntry: IChatroomEntry
callback: ICallback<void, void>
Returns void
getAllChatroomEntries
- getAllChatroomEntries(chatRoomId: string, callback: ICallback<{}, void>): void
Parameters
chatRoomId: string
callback: ICallback<{}, void>
Returns void
getAppInfo
- getAppInfo(): { appKey: string }
Returns { appKey: string }
getBlacklist
- getBlacklist(callback: ICallback<string[], void>): void
Parameters
callback: ICallback<string[], void>
Returns void
getBlacklistStatus
- getBlacklistStatus(userId: string, callback: ICallback<string, void>): void
Parameters
userId: string
callback: ICallback<string, void>
Returns void
getChannel
Parameters
getChatRoomHistoryMessages
- getChatRoomHistoryMessages(chatRoomId: string, count: number, order: 0 | 1, callback: ICallback<IReceivedMessageV2[], boolean>, timestamp?: number): void
Parameters
chatRoomId: string
count: number
order: 0 | 1
callback: ICallback<IReceivedMessageV2[], boolean>
timestamp: number = 0
Returns void
getChatRoomInfo
- getChatRoomInfo(chatRoomId: string, count: number, order: 1 | 2, callback: ICallback<IV2ChatRoomInfo, void>): void
Parameters
chatRoomId: string
count: number
order: 1 | 2
callback: ICallback<IV2ChatRoomInfo, void>
Returns void
getChatroomEntry
- getChatroomEntry(chatRoomId: string, key: string, callback: ICallback<string, void>): void
Parameters
chatRoomId: string
key: string
callback: ICallback<string, void>
Returns void
getConversation
Parameters
Returns void
getConversationList
- getConversationList(callback: ICallback<IConversation[], void>, conversationTypes: null | Number[], count?: number): void
Parameters
callback: ICallback<IConversation[], void>
conversationTypes: null | Number[]
Optional count: number
Returns void
getConversationListByTag
- getConversationListByTag(tagId: string, count: number, startTime: number, callback: ICallback<IV2ConversationContainTag[], void>): void
Parameters
tagId: string
count: number
startTime: number
callback: ICallback<IV2ConversationContainTag[], void>
Returns void
getConversationNotificationStatus
- getConversationNotificationStatus(conversationType: ConversationType, targetId: string, callback: ICallback<NotificationStatus, void>): void
Parameters
targetId: string
callback: ICallback<NotificationStatus, void>
Returns void
getConversationUnreadCount
- getConversationUnreadCount(conversationType: ConversationType, callback: ICallback<number, void>): void
Parameters
callback: ICallback<number, void>
Returns void
getCurrentConnectionStatus
getCurrentUserId
- getCurrentUserId(): string
Returns string
getFileToken
- getFileToken(fileType: FileType, callback: ICallback<IUploadAuth & { bos: string; qiniu: string }, void>, fileName?: string, httpMethod?: "PUT" | "POST", queryString?: string): void
Parameters
callback: ICallback<IUploadAuth & { bos: string; qiniu: string }, void>
Optional fileName: string
Optional httpMethod: "PUT" | "POST"
Optional queryString: string
Returns void
getFileUrl
- getFileUrl(fileType: FileType, fileName: string, saveName: string, callback: ICallback<IGetFileUrl, void>, uploadRes?: { downloadUrl: string; isBosRes: boolean }, serverType?: UploadMethod): void
Parameters
fileName: string
saveName: string
callback: ICallback<IGetFileUrl, void>
Optional uploadRes: { downloadUrl: string; isBosRes: boolean }
downloadUrl: string
isBosRes: boolean
Returns void
getFirstUnreadMessage
- getFirstUnreadMessage(conversationType: ConversationType, targetId: string, callback: ICallback<null | IReceivedMessageV2, void>): void
Parameters
targetId: string
callback: ICallback<null | IReceivedMessageV2, void>
Returns void
getHistoryMessages
- getHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, callback: ICallback<IReceivedMessageV2[], boolean>, objectName?: string, order?: 0 | 1): void
Parameters
targetId: string
timestamp: number
count: number
callback: ICallback<IReceivedMessageV2[], boolean>
Optional objectName: string
Optional order: 0 | 1
Returns void
getMessage
- getMessage(messageId: number, callback: ICallback<IReceivedMessageV2, void>): void
Parameters
messageId: number
callback: ICallback<IReceivedMessageV2, void>
Returns void
getMessageReader
- getMessageReader(messageUId: string, targetId: string, callback: ICallback<IMessageReaderResponse, void>): void
Parameters
messageUId: string
targetId: string
Returns void
getNavi
- getNavi(): {} | INaviInfo
Returns {} | INaviInfo
getRTCData
- getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, callback: ICallback<KVString, void>): void
Parameters
roomId: string
keys: string[]
isInner: boolean
apiType: RTCApiType
callback: ICallback<KVString, void>
Returns void
getRTCOutData
- getRTCOutData(roomId: string, userIds: string[], callback: ICallback<void, void>): void
Parameters
roomId: string
userIds: string[]
callback: ICallback<void, void>
Returns void
getRTCRoomData
- getRTCRoomData(roomId: string, keys: string[], isInner: boolean, callback: ICallback<KVString, void>): void
Parameters
roomId: string
keys: string[]
isInner: boolean
callback: ICallback<KVString, void>
Returns void
getRTCRoomInfo
- getRTCRoomInfo(room: RTCRoomOption, callback: ICallback<IRTCRoomInfo, void>): void
Parameters
room: RTCRoomOption
callback: ICallback<IRTCRoomInfo, void>
Returns void
getRTCToken
- getRTCToken(room: RTCRoomOption, callback: ICallback<IRtcTokenData, void>): void
Parameters
room: RTCRoomOption
callback: ICallback<IRtcTokenData, void>
Returns void
getRTCUserData
- getRTCUserData(roomId: string, keys: string[], isInner: boolean, callback: ICallback<KVString, void>): void
Parameters
roomId: string
keys: string[]
isInner: boolean
callback: ICallback<KVString, void>
Returns void
getRTCUserInfoList
- getRTCUserInfoList(room: RTCRoomOption, callback: ICallback<{}, void>): void
Parameters
room: RTCRoomOption
callback: ICallback<{}, void>
Returns void
getRTCUserList
- getRTCUserList(room: RTCRoomOption, callback: ICallback<IRTCUsers, void>): void
Parameters
room: RTCRoomOption
callback: ICallback<IRTCUsers, void>
Returns void
getRemoteHistoryMessages
- getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, callback: ICallback<IReceivedMessageV2[], boolean>, options?: { order?: 0 | 1 }): void
Parameters
targetId: string
timestamp: number
count: number
callback: ICallback<IReceivedMessageV2[], boolean>
options: { order?: 0 | 1 } = {}
Returns void
getSDKInfo
- getSDKInfo(): { version: string }
Returns { version: string }
getServerTime
Returns number
getTagList
- getTagList(callback: ICallback<ITagInfo[], void>): void
Parameters
callback: ICallback<ITagInfo[], void>
Returns void
getTagsForConversation
- getTagsForConversation(conversation: IConversationOption, callback: ICallback<IConversationTag[], void>): void
Parameters
conversation: IConversationOption
callback: ICallback<IConversationTag[], void>
Returns void
getTextMessageDraft
- getTextMessageDraft(conversationType: ConversationType, targetId: string): undefined | string
Parameters
Returns undefined | string
getTotalUnreadCount
- getTotalUnreadCount(callback: ICallback<number, void>, conversationTypes?: ConversationType[], includeMuted?: boolean): void
Parameters
callback: ICallback<number, void>
Optional includeMuted: boolean
Returns void
getUnreadCount
- getUnreadCount(conversationType: ConversationType, targetId: string, callback: ICallback<number, void>): void
Parameters
targetId: string
callback: ICallback<number, void>
Returns void
getUnreadCountByTag
- getUnreadCountByTag(tagId: string, containMuted: boolean, callback: ICallback<number, void>): void
Parameters
tagId: string
containMuted: boolean
callback: ICallback<number, void>
Returns void
getUnreadMentionedMessages
- getUnreadMentionedMessages(conversationType: ConversationType, targetId: string): null | IReceivedMessageV2[]
Parameters
Returns null | IReceivedMessageV2[]
getUserStatus
- getUserStatus(userId: string, callback: ICallback<{ status?: number }, void>): void
Parameters
userId: string
callback: ICallback<{ status?: number }, void>
Returns void
hasRemoteUnreadMessages
- hasRemoteUnreadMessages(token: string, callback: ICallback<Boolean, void>): void
Parameters
token: string
callback: ICallback<Boolean, void>
Returns void
insertMessage
- insertMessage(conversationType: ConversationType, targetId: string, content: IReceivedMessageV2, callback: ICallback<IReceivedMessageV2, void>, options?: IInsertOptions): void
Parameters
targetId: string
content: IReceivedMessageV2
callback: ICallback<IReceivedMessageV2, void>
options: IInsertOptions = {}
Returns void
install
- install<T, O>(plugin: IPluginGenerator<T, O>, options: O): null | T
Type parameters
Parameters
plugin: IPluginGenerator<T, O>
options: O
Returns null | T
joinChatRoom
- joinChatRoom(chatRoomId: string, count: number, callback: ICallback<void, void>): void
Parameters
chatRoomId: string
count: number
callback: ICallback<void, void>
Returns void
joinRTCRoom
- joinRTCRoom(room: RTCRoomOption, callback: ICallback<IJoinRTCRoomData, void>): void
Parameters
room: RTCRoomOption
callback: ICallback<IJoinRTCRoomData, void>
Returns void
logout
Returns Promise<void>
quitChatRoom
- quitChatRoom(chatRoomId: string, callback: ICallback<void, void>): void
Parameters
chatRoomId: string
callback: ICallback<void, void>
Returns void
quitRTCRoom
- quitRTCRoom(room: RTCRoomOption, callback: ICallback<boolean, void>): void
Parameters
room: RTCRoomOption
callback: ICallback<boolean, void>
Returns void
removeChatRoomEntries
- removeChatRoomEntries(chatRoomId: string, options: { entries: string[] }, callback: ICallback<void, void>): void
Parameters
chatRoomId: string
options: { entries: string[] }
callback: ICallback<void, void>
Returns void
removeChatroomEntry
- removeChatroomEntry(chatRoomId: string, chatroomEntry: IRemoveChatRoomEntryOption, callback: ICallback<void, void>): void
Parameters
chatRoomId: string
chatroomEntry: IRemoveChatRoomEntryOption
callback: ICallback<void, void>
Returns void
removeConversation
- removeConversation(conversationType: ConversationType, targetId: string, callback: ICallback<void, void>): void
Parameters
targetId: string
callback: ICallback<void, void>
Returns void
removeFromBlacklist
- removeFromBlacklist(userId: string, callback: ICallback<void, void>): void
Parameters
userId: string
callback: ICallback<void, void>
Returns void
removeMessageExpansionForKey
- removeMessageExpansionForKey(keys: string[], message: IReceivedMessageV2, callback: ICallback<void, void>): void
Parameters
keys: string[]
message: IReceivedMessageV2
callback: ICallback<void, void>
Returns void
removeRTCData
- removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, callback: ICallback<boolean, void>, message?: { content: string; name: string }): void
Parameters
roomId: string
keys: string[]
isInner: boolean
apiType: RTCApiType
callback: ICallback<boolean, void>
Optional message: { content: string; name: string }
content: string
name: string
Returns void
removeRTCRoomData
- removeRTCRoomData(roomId: string, keys: string[], isInner: boolean, callback: ICallback<boolean, void>, message?: any): void
Parameters
roomId: string
keys: string[]
isInner: boolean
callback: ICallback<boolean, void>
Optional message: any
Returns void
removeRTCRoomInfo
- removeRTCRoomInfo(room: RTCRoomOption, info: any, callback: ICallback<boolean, void>): void
Parameters
room: RTCRoomOption
info: any
callback: ICallback<boolean, void>
Returns void
removeRTCUserData
- removeRTCUserData(roomId: string, keys: string[], isInner: boolean, callback: ICallback<boolean, void>, message?: { content: string; name: string }): void
Parameters
roomId: string
keys: string[]
isInner: boolean
callback: ICallback<boolean, void>
Optional message: { content: string; name: string }
content: string
name: string
Returns void
removeRTCUserInfo
- removeRTCUserInfo(room: RTCRoomOption, info: { keys: string[] }, callback: ICallback<boolean, void>): void
Parameters
room: RTCRoomOption
info: { keys: string[] }
callback: ICallback<boolean, void>
Returns void
removeTag
- removeTag(tagId: string, callback: ICallback<void, void>): void
Parameters
tagId: string
callback: ICallback<void, void>
Returns void
removeTagForConversations
- removeTagForConversations(tagId: string, conversations: IConversationOption[], callback: ICallback<void, void>): void
Parameters
tagId: string
conversations: IConversationOption[]
callback: ICallback<void, void>
Returns void
removeTagsForConversation
- removeTagsForConversation(conversation: IConversationOption, tagIds: string[], callback: ICallback<void, void>): void
Parameters
conversation: IConversationOption
tagIds: string[]
callback: ICallback<void, void>
Returns void
saveTextMessageDraft
- saveTextMessageDraft(conversationType: ConversationType, targetId: string, draftText: string): boolean
Parameters
targetId: string
draftText: string
Returns boolean
searchConversationByContent
- searchConversationByContent(keyword: string, callback: ICallback<IConversation[], void>, conversationTypes?: ConversationType[], customMessageTypes?: string[]): void
Parameters
keyword: string
callback: ICallback<IConversation[], void>
Optional customMessageTypes: string[]
Returns void
searchMessageByContent
- searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, callback: ICallback<IReceivedMessageV2[], number>): void
Parameters
targetId: string
keyword: string
timestamp: number
count: number
total: number
callback: ICallback<IReceivedMessageV2[], number>
Returns void
sendMessage
- sendMessage(conversationType: ConversationType, targetId: string, msg: BaseMessage<any>, callback: ISendCallback<IReceivedMessageV2, void>, isMentioned?: boolean, pushContent?: string, pushData?: string, methodType?: number, options?: ISendOptionsV2): void
Parameters
targetId: string
msg: BaseMessage<any>
callback: ISendCallback<IReceivedMessageV2, void>
Optional isMentioned: boolean
Optional pushContent: string
Optional pushData: string
Optional methodType: number
Optional options: ISendOptionsV2
Returns void
sendReadReceiptMessage
- sendReadReceiptMessage(messageUIds: string[], targetId: string, callback: ICallback<void, void>): void
Parameters
messageUIds: string[]
targetId: string
callback: ICallback<void, void>
Returns void
sendRecallMessage
- sendRecallMessage(message: IReceivedMessageV2, callback: ICallback<IReceivedMessageV2, void>, options?: ISendOptionsV2): void
Parameters
message: IReceivedMessageV2
callback: ICallback<IReceivedMessageV2, void>
Optional options: ISendOptionsV2
Returns void
sendReceiptResponse
- sendReceiptResponse(conversationType: ConversationType, targetId: string, callback: ICallback<null | IReceivedMessageV2, void>): void
Parameters
targetId: string
callback: ICallback<null | IReceivedMessageV2, void>
Returns void
sendTypingStatusMessage
- sendTypingStatusMessage(conversationType: ConversationType, targetId: string, typingContentType: string, callback: ICallback<IReceivedMessageV2, void>): void
Parameters
targetId: string
typingContentType: string
callback: ICallback<IReceivedMessageV2, void>
Returns void
setChatRoomEntries
- setChatRoomEntries(chatRoomId: string, options: IChatroomEntries, callback: ICallback<void, void>): void
Parameters
chatRoomId: string
options: IChatroomEntries
callback: ICallback<void, void>
Returns void
setChatroomEntry
- setChatroomEntry(chatRoomId: string, chatroomEntry: IChatroomEntry, callback: ICallback<void, void>): void
Parameters
chatRoomId: string
chatroomEntry: IChatroomEntry
callback: ICallback<void, void>
Returns void
setConversationStatus
- setConversationStatus(conversationType: ConversationType, targetId: string, status: IConversationStatus, callback: ICallback<void, void>): void
Parameters
targetId: string
status: IConversationStatus
callback: ICallback<void, void>
Returns void
setConversationStatusInTag
- setConversationStatusInTag(tagId: string, conversation: IConversationOption, status: { isTop: boolean }, callback: ICallback<void, void>): void
Parameters
tagId: string
conversation: IConversationOption
status: { isTop: boolean }
callback: ICallback<void, void>
Returns void
setDeviceInfo
- setDeviceInfo(option: { id: string }): void
Parameters
Returns void
setMessageContent
- setMessageContent(messageId: number, content: any, objectName: string): void
Parameters
messageId: number
content: any
objectName: string
Returns void
setMessageReceivedStatus
- setMessageReceivedStatus(messageId: number, receivedStatus: number, callback: ICallback<boolean, void>): void
Parameters
messageId: number
receivedStatus: number
callback: ICallback<boolean, void>
Returns void
setMessageSearchField
- setMessageSearchField(messageId: number, content: any, searchFiles: string): void
Parameters
messageId: number
content: any
searchFiles: string
Returns void
setMessageSentStatus
- setMessageSentStatus(messageId: number, sentStatus: number, callback: ICallback<boolean, void>): void
Parameters
messageId: number
sentStatus: number
callback: ICallback<boolean, void>
Returns void
setRTCData
- setRTCData(roomId: string, key: string, value: string, isInner: boolean, apiType: RTCApiType, callback: ICallback<boolean, void>, message?: { content: string; name: string }): void
Parameters
roomId: string
key: string
value: string
isInner: boolean
apiType: RTCApiType
callback: ICallback<boolean, void>
Optional message: { content: string; name: string }
content: string
name: string
Returns void
setRTCOutData
- setRTCOutData(roomId: string, data: any, type: number, callback: ICallback<boolean, void>, message?: any): void
Parameters
roomId: string
data: any
type: number
callback: ICallback<boolean, void>
Optional message: any
Returns void
setRTCRoomData
- setRTCRoomData(roomId: string, key: string, value: string, isInner: boolean, callback: ICallback<boolean, void>, message?: { content: string; name: string }): void
Parameters
roomId: string
key: string
value: string
isInner: boolean
callback: ICallback<boolean, void>
Optional message: { content: string; name: string }
content: string
name: string
Returns void
setRTCRoomInfo
- setRTCRoomInfo(room: RTCRoomOption, info: any, callback: ICallback<boolean, void>): void
Parameters
room: RTCRoomOption
info: any
callback: ICallback<boolean, void>
Returns void
setRTCState
- setRTCState(room: RTCRoomOption, content: { report: string }, callback: ICallback<boolean, void>): void
Parameters
room: RTCRoomOption
content: { report: string }
callback: ICallback<boolean, void>
Returns void
setRTCUserData
- setRTCUserData(roomId: string, key: string, value: string, isInner: boolean, callback: ICallback<boolean, void>, message?: { content: string; name: string }): void
Parameters
roomId: string
key: string
value: string
isInner: boolean
callback: ICallback<boolean, void>
Optional message: { content: string; name: string }
content: string
name: string
Returns void
setRTCUserInfo
- setRTCUserInfo(room: RTCRoomOption, info: { key: string; value: string }, callback: ICallback<boolean, void>): void
Parameters
room: RTCRoomOption
info: { key: string; value: string }
callback: ICallback<boolean, void>
Returns void
setRTCUserTotalRes
- setRTCUserTotalRes(roomId: string, message: { content: string; name: string }, valueInfo: string, objectName: string, callback: ICallback<boolean, void>): void
Parameters
roomId: string
message: { content: string; name: string }
content: string
name: string
valueInfo: string
objectName: string
callback: ICallback<boolean, void>
Returns void
setUserStatus
- setUserStatus(status: number, callback: ICallback<Boolean, void>): void
Parameters
status: number
callback: ICallback<Boolean, void>
Returns void
setUserStatusListener
- setUserStatusListener(config: { userIds: string[] }, listener: Function): void
Parameters
config: { userIds: string[] }
listener: Function
Returns void
updateMessageExpansion
- updateMessageExpansion(expansionDic: {}, message: IReceivedMessageV2, callback: ICallback<void, void>): void
Parameters
expansionDic: {}
message: IReceivedMessageV2
callback: ICallback<void, void>
Returns void
updateTag
- updateTag(tag: ITagParam, callback: ICallback<void, void>): void
Parameters
tag: ITagParam
callback: ICallback<void, void>
Returns void
添加会话到指定标签