You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
7.8 KiB
92 lines
7.8 KiB
import { ZIMLogger, ZIMLogTag, ZIMLogAction } from './ZIMLogger';
|
|
import { ZIMError, ZIMMediaFileType, ZIMUserInfo, ZIMConversationType, ZIMConversationQueryConfig, ZIMCallInviteConfig, ZIMConversationNotificationStatus, ZIMMessageBase, ZIMMessageSendConfig, ZIMMediaMessageBase, ZIMMessage, ZIMMessageDeleteConfig, ZIMMessageQueryConfig, ZIMGroupMessageReceiptMemberQueryConfig, ZIMMediaMessage, ZIMRoomInfo, ZIMRoomAdvancedConfig, ZIMRoomMemberQueryConfig, ZIMRoomMemberAttributesQueryConfig, ZIMGroupInfo, ZIMGroupAdvancedConfig, ZIMConversationSearchConfig, ZIMMessageSearchConfig, ZIMGroupSearchConfig, ZIMGroupMemberSearchConfig, ZIMCombineMessage, ZIMGroupMuteConfig, ZIMFriendAddConfig, ZIMFriendApplicationAcceptConfig, ZIMGroupVerifyType, ZIMUserOfflinePushRule } from '../index';
|
|
export declare const NotInitError: ZIMError;
|
|
/**
|
|
* Valid API params
|
|
*
|
|
* Used for Web and RN and uni-app
|
|
*/
|
|
export declare class ZIMParamValid {
|
|
private logger;
|
|
constructor(logger: ZIMLogger);
|
|
validID(field: string, value: string, tag: ZIMLogTag, action: ZIMLogAction): ZIMError | void;
|
|
validName(field: string, value: string, tag: ZIMLogTag, action: ZIMLogAction): ZIMError | void;
|
|
validTwoID(field1: string, value1: string, field2: string, value2: string, tag: ZIMLogTag, action: ZIMLogAction | string): ZIMError | void;
|
|
validTwoName(field1: string, value1: string, field2: string, value2: string, tag: ZIMLogTag, action: ZIMLogAction): ZIMError | void;
|
|
validIDAndName(field1: string, value1: string, field2: string, value2: string, tag: ZIMLogTag, action: ZIMLogAction): ZIMError | void;
|
|
login(userInfo: ZIMUserInfo): ZIMError | void;
|
|
queryUsersInfo(userIDs: string[]): ZIMError | void;
|
|
validIDAndArray(field1: string, value1: string, field2: string, value2: string[], tag: ZIMLogTag, action: ZIMLogAction, max?: number): ZIMError | void;
|
|
updateUserOfflinePushRule(offlinePushRule: ZIMUserOfflinePushRule): ZIMError | void;
|
|
validConvIDAndType(conversationID: string, conversationType: ZIMConversationType, action: ZIMLogAction): ZIMError | void;
|
|
queryConversationList(config: ZIMConversationQueryConfig, action: ZIMLogAction): ZIMError | void;
|
|
setConversationNotificationStatus(status: ZIMConversationNotificationStatus, conversationID: string, conversationType: ZIMConversationType): ZIMError | void;
|
|
updateConversationPinnedState(isPinned: boolean, conversationID: string, conversationType: ZIMConversationType): ZIMError | void;
|
|
setConversationDraft(conversationID: string, conversationType: ZIMConversationType, draft: string): ZIMError | void;
|
|
sendMessage(message: ZIMMessageBase, toConversationID: string, conversationType: ZIMConversationType, config: ZIMMessageSendConfig): ZIMError | void;
|
|
sendMediaMessage(message: ZIMMediaMessageBase, toConversationID: string, conversationType: ZIMConversationType, config: ZIMMessageSendConfig): ZIMError | void;
|
|
deleteMessages(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageDeleteConfig): ZIMError | void;
|
|
queryHistoryMessage(conversationID: string, conversationType: ZIMConversationType, config: ZIMMessageQueryConfig): ZIMError | void;
|
|
downloadMediaFile(message: ZIMMediaMessage, fileType: ZIMMediaFileType): ZIMError | void;
|
|
insertMessageToLocalDB(message: ZIMMessageBase | ZIMMediaMessageBase, conversationID: string, conversationType: ZIMConversationType, senderUserID: string): ZIMError | void;
|
|
updateMessageLocalExtendedData(localExtendedData: string, message: ZIMMessage): ZIMError | void;
|
|
sendCombineMessage(message: ZIMCombineMessage, titleLength: number, summaryLength: number): ZIMError | void;
|
|
queryCombineMessageDetail(message: ZIMCombineMessage): ZIMError | void;
|
|
sendConversationMessageReceiptRead(conversationID: string, conversationType: ZIMConversationType): ZIMError | void;
|
|
sendMessageReceiptsRead(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType): ZIMError | void;
|
|
queryMessageReceiptsInfo(messageList: ZIMMessage[], conversationID: string, conversationType: ZIMConversationType): ZIMError | void;
|
|
queryGroupMessageReceiptMemberList(message: ZIMMessage, groupID: string, config: ZIMGroupMessageReceiptMemberQueryConfig, read: boolean, loginUserID: string): ZIMError | void;
|
|
revokeMessage(message: ZIMMessage, loginUserID: string): ZIMError | void;
|
|
messageReaction(reactionType: string, message: ZIMMessage, add?: boolean): ZIMError | void;
|
|
queryMessageReactionUserList(message: ZIMMessage, config: ZIMGroupMessageReceiptMemberQueryConfig): ZIMError | void;
|
|
createRoom(roomInfo: ZIMRoomInfo, config?: ZIMRoomAdvancedConfig, enter?: boolean): ZIMError | void;
|
|
queryRoomMemberList(roomID: string, config: ZIMRoomMemberQueryConfig): ZIMError | void;
|
|
queryRoomMembers(userIDs: string[], roomID: string): ZIMError | void;
|
|
setRoomAttributes(roomAttributes: Record<string, string>, roomID: string): ZIMError | void;
|
|
deleteRoomAttributes(keys: string[], roomID: string): ZIMError | void;
|
|
setRoomMembersAttributes(attributes: Record<string, string>, userIDs: string[], roomID: string): ZIMError | void;
|
|
queryRoomMembersAttributes(userIDs: string[], roomID: string): ZIMError | void;
|
|
queryRoomMemberAttributesList(roomID: string, config: ZIMRoomMemberAttributesQueryConfig): ZIMError | void;
|
|
validGroupUserIDs(userIDs: string[], groupID: string, action: ZIMLogAction): ZIMError | void;
|
|
createGroup(groupInfo: ZIMGroupInfo, userIDs: string[], config: ZIMGroupAdvancedConfig): ZIMError | void;
|
|
muteGroup(groupID: string, config: ZIMGroupMuteConfig, isMute: boolean): ZIMError | void;
|
|
setGroupAttributes(groupAttributes: Record<string, string>, groupID: string): ZIMError | void;
|
|
deleteGroupAttributes(keys: string[], groupID: string): ZIMError | void;
|
|
queryGroupAttributes(groupID: string, keys?: string[]): ZIMError | void;
|
|
setGroupMemberNickname(nickname: string, forUserID: string, groupID: string): ZIMError | void;
|
|
setGroupMemberRole(role: number, forUserID: string, groupID: string): ZIMError | void;
|
|
updateGroupVerifyMode(mode: number, groupID: string, type: ZIMGroupVerifyType): ZIMError | void;
|
|
callInvite(invitees: string[], config: ZIMCallInviteConfig): ZIMError | void;
|
|
callCancel(invitees: string[], callID: string): ZIMError | void;
|
|
callIDAndInvitees(invitees: string[], callID: string, action: ZIMLogAction): ZIMError | void;
|
|
addFriend(userID: string, config: ZIMFriendAddConfig): ZIMError | void;
|
|
updateFriendAlias(friendAlias: string, userID: string): ZIMError | void;
|
|
updateFriendAttributes(friendAttributes: Record<string, string>, userID: string): ZIMError | void;
|
|
acceptFriendApplication(userID: string, config: ZIMFriendApplicationAcceptConfig): ZIMError | void;
|
|
validCount(config: {
|
|
count: number;
|
|
}, tag: ZIMLogTag, action: ZIMLogAction, field?: string, value?: string): ZIMError | void;
|
|
validArray(field: string, value: string[], tag: ZIMLogTag, action: ZIMLogAction, max?: number): ZIMError | void;
|
|
private _checkMediaFileType;
|
|
/**
|
|
* Message content
|
|
*
|
|
* 1. not empty
|
|
* 2. cannot be a string of all spaces
|
|
* 3. byte <= 48K
|
|
*/
|
|
private _checkMesageContent;
|
|
private _checkMesagePriority;
|
|
private _checkMesageType;
|
|
private _checkMediaMesageType;
|
|
private _checkInsertMesageType;
|
|
private _checkInsertMesageContent;
|
|
private _checkConvType;
|
|
private _checkMessageReceipt;
|
|
private _isValidName;
|
|
private _isValidAttribute;
|
|
searchConversations(config: ZIMConversationSearchConfig): ZIMError | void;
|
|
searchMessages(config: ZIMMessageSearchConfig, action: ZIMLogAction): ZIMError | void;
|
|
searchGroups(config: ZIMGroupSearchConfig): ZIMError | void;
|
|
searchGroupMembers(groupID: string, config: ZIMGroupMemberSearchConfig): ZIMError | void;
|
|
}
|
|
|