easemob-websdk 4.24.1 → 5.0.0

package/types/groupApi.d.ts

@@ -1,306 +0,0 @@
-/**
- * group types
- * @module TYPES
- */
-import { UserId } from './common';
-interface BaseGroupInfo {
-	/** The group ID. */
-	groupid: string;
-	/** The group name. */
-	groupname: string;
-}
-export declare type GroupAffiliation =
-	| {
-			/** The group owner. */
-			owner: UserId;
-			/** The Unix timestamp when the owner joined the group. */
-			joined_time: number;
-	  }
-	| {
-			/** The group member. */
-			member: UserId;
-			/** The Unix timestamp when the user joins the group. */
-			joined_time: number;
-	  };
-interface CreateGroupResult {
-	/** The group ID. */
-	groupid: string;
-}
-interface BlockGroupResult {
-	/** Whether the current user is enabled. */
-	activated: boolean;
-	/** The Unix timestamp when the user is created. */
-	created: number;
-	/** The Unix timestamp when the user information was last edited. */
-	modified: number;
-	/** User nickname for push. */
-	nickname: string;
-	/** The user type. */
-	type: string;
-	/** The user ID. */
-	username: string;
-	/** The user uuid. */
-	uuid: string;
-}
-interface ChangeGroupOwnerResult {
-	/** The group owner change result. */
-	newowner: boolean;
-}
-interface GroupDetailInfo {
-	/** The list of existing members. */
-	affiliations: GroupAffiliation[];
-	/** The number of existing members. */
-	affiliations_count: number;
-	/** Whether to allow group members to invite others to join the group. */
-	allowinvites: boolean;
-	/** The Unix timestamp when the group is created. */
-	created: number;
-	/** The custom information. */
-	custom: string;
-	/** The group description. */
-	description: string;
-	/** The group ID. */
-	id: string;
-	/** The maximum number of group members. */
-	maxusers: number;
-	/** Whether a user requires the approval from the group owner or admin to join the group. -`true`: Yes; -`false`: No. */
-	membersonly: boolean;
-	/** Whether to mute all members. -`true`: Yes; -`false`: No.*/
-	mute: boolean;
-	/** The group name. */
-	name: string;
-	/** The group owner. */
-	owner: UserId;
-	/** Whether it is a public group. */
-	public: boolean;
-	/** Whether the member is on the blocklist. -`true`: Yes; -`false`: No. */
-	shieldgroup: boolean;
-	/** The group avatar. */
-	avatar: string;
-}
-interface ModifyGroupResult {
-	/** Whether the group description is modified successfully. -`true`: Yes; -`false`: No. */
-	description?: boolean;
-	/** Whether the maximum number of group members is changed successfully. -`true`: Yes; -`false`: No.*/
-	maxusers?: boolean;
-	/** Whether the group name is changed successfully. -`true`: Yes; -`false`: No.*/
-	groupname?: boolean;
-	/** Whether requiring approval is changed successfully. -`true`: Yes; -`false`: No. */
-	membersonly?: boolean;
-	/** Whether allowing a group member to invite others is modified successfully. -`true`: Yes; -`false`: No.*/
-	allowinvites?: boolean;
-	/** Whether the group avatar is changed successfully. -`true`: Yes; -`false`: No. */
-	avatar?: boolean;
-}
-declare type GroupMember =
-	| {
-			owner: UserId;
-	  }
-	| {
-			member: UserId;
-	  };
-interface SetGroupAdminResult {
-	/** The user ID of the new admin. */
-	newadmin: UserId;
-	/** The setting result. */
-	result: 'success';
-}
-interface RemoveGroupAdminResult {
-	/** The user ID of a removed admin. */
-	oldadmin: UserId;
-	/** The setting result. */
-	result: 'success';
-}
-interface DestroyGroupResult {
-	/** The group ID. */
-	id: string;
-	/** The operation result. */
-	success: boolean;
-}
-interface InviteUsersToGroupResult {
-	/** The action. */
-	action: 'invite';
-	/** The group ID. */
-	id: string;
-	/** The reason for failure. */
-	reason?: string;
-	/** The invitation result. - `true`: The invitation is delivered successfully; - `false`: The invitation fails to be delivered. */
-	result: boolean;
-	/** The invitee ID. */
-	user: UserId;
-}
-
-interface GroupInfo {
-	/** The number of existing members. */
-	affiliationsCount?: number;
-	/** The group name. */
-	groupName: string;
-	/** The group ID. */
-	groupId: string;
-	/** The current user role in the group. */
-	role?: 'member' | 'admin' | 'owner';
-	/** Whether the group disabled. */
-	disabled: boolean;
-	/** Whether a user requires the approval from the group owner or admin to join the group. -`true`: Yes; -`false`: No. */
-	approval: boolean;
-	/** Whether to allow group members to invite others to join the group. */
-	allowInvites: boolean;
-	/** The group description. */
-	description: string;
-	/** The maximum number of group members. */
-	maxUsers: number;
-	/** Whether it is a public group. */
-	public: boolean;
-}
-
-interface RemoveGroupMemberResult {
-	/** The action. */
-	action: 'remove_member';
-	/** The group ID. */
-	groupid: string;
-	/** The invitation result. - `true`: Success; - `false`: Failure.*/
-	result: boolean;
-	/** The user ID. */
-	user: UserId;
-}
-interface MuteGroupMemberResult {
-	/** The mute duration in milliseconds. */
-	expire: number;
-	/** The operation result. - `true`: Succeed; - `false`: Failed.*/
-	result: boolean;
-	/** The ID of the muted member. */
-	user: UserId;
-}
-interface UnmuteGroupMemberResult {
-	/** The operation result. - `true`: Succeed; - `false`: Failed.*/
-	result: boolean;
-	/** The ID of the unmuted member. */
-	user: UserId;
-}
-interface GetGroupMuteListResult {
-	/** The mute duration in milliseconds. */
-	expire: number;
-	/** The ID of the muted user. */
-	user: UserId;
-}
-interface GroupRequestResult {
-	/** The action. */
-	action: string;
-	/** The group ID. */
-	groupid: string;
-	/** The invitation result. - `true`: Succeed; - `false`: Failed. */
-	result: boolean;
-	/** The user ID. */
-	user: UserId;
-}
-interface IsInGroupWhiteListResult {
-	/** The user ID to query. */
-	member: UserId;
-	/** Whether the user is on the allowlist. -`true`: Yes; -`false`: No.*/
-	white: boolean;
-}
-interface GetGroupMsgReadUserResult {
-	/** The message ID to query. */
-	ackmid: string;
-	/** Whether the message is the last one.  -`true`: Yes; -`false`: No.*/
-	is_last: boolean;
-	/** The cursor for next pagination query. It specifies where to start to get the next page of data.*/
-	next_key: string;
-	/** The Unix timestamp of the current query. */
-	timestamp: number;
-	/** The number of members that have read the message. */
-	total: number;
-	/** The list of members that have read this message. */
-	userlist: UserId[];
-}
-interface UpdateGroupAnnouncementResult {
-	/** The group ID. */
-	id: string;
-	/** The operation result. - `true`: Success; - `false`: Failure.*/
-	result: boolean;
-}
-interface DeleteGroupSharedFileResult {
-	/** The group ID. */
-	group_id: string;
-	/** The file ID. */
-	file_id: string;
-	/** The operation result. - `true`: Success; - `false`: Failure.*/
-	result: boolean;
-}
-interface FetchGroupSharedFileListResult {
-	/** The file ID. */
-	file_id: string;
-	/** The file name. */
-	file_name: string;
-	/** The file owner. */
-	file_owner: string;
-	/** The file size. */
-	file_size: number;
-	/** The Unix timestamp when the file is uploaded.*/
-	created: number;
-}
-interface GroupModifyInfo {
-	/** The name of a group.  */
-	name?: string;
-	/** The description of a group.  */
-	description?: string;
-	/** Whether it is a public group. -`true`: Yes; -`false`: No. Public group: the group that others can query by calling `listgroups`. */
-	public?: boolean;
-	/** Whether a user requires the approval from the group owner or admin to join the group. -`true`: Yes; -`false`: No. */
-	approval?: boolean;
-	/** Whether to allow group members to invite others to join the group. */
-	allowInvites?: boolean;
-	/** The maximum number of group members */
-	maxUsers?: number;
-	/** Whether the invitee needs to accept the invitation before joining the group.
-  - `true`: The invitee's consent is required. The default value is `true`.
-  - `false`: The invitee will be directly added to the group without confirmation.
-  */
-	inviteNeedConfirm?: boolean;
-	/** Group detail extensions. */
-	ext?: string;
-	/** Last Modified Timestamp.  */
-	lastModified?: number;
-	/** The group avatar. */
-	avatar?: string;
-}
-
-declare type MemberAttributes = Record<string, string>;
-
-declare type GetGroupMembersAttributesResult = Record<UserId, MemberAttributes>;
-
-type GroupMemberRole = 'owner' | 'admin' | 'member';
-interface FetchedGroupMember {
-	role: GroupMemberRole;
-	userId: UserId;
-	joinedTime: number;
-}
-
-export type {
-	GroupRequestResult,
-	BaseGroupInfo,
-	CreateGroupResult,
-	BlockGroupResult,
-	ChangeGroupOwnerResult,
-	GroupDetailInfo,
-	ModifyGroupResult,
-	GroupMember,
-	SetGroupAdminResult,
-	RemoveGroupAdminResult,
-	DestroyGroupResult,
-	InviteUsersToGroupResult,
-	RemoveGroupMemberResult,
-	MuteGroupMemberResult,
-	UnmuteGroupMemberResult,
-	GetGroupMuteListResult,
-	IsInGroupWhiteListResult,
-	GetGroupMsgReadUserResult,
-	UpdateGroupAnnouncementResult,
-	DeleteGroupSharedFileResult,
-	FetchGroupSharedFileListResult,
-	GroupInfo,
-	GroupModifyInfo,
-	MemberAttributes,
-	GetGroupMembersAttributesResult,
-	FetchedGroupMember,
-};

package/types/indexApi.d.ts

@@ -1,366 +0,0 @@
-import { Jid, UserId } from './common';
-import {
-	MessagesType,
-	MessageBody,
-	ModifiedMsgInfo,
-	ExcludeAckMessageBody,
-	ChatType,
-	MessageType,
-} from './message';
-interface UpdateOwnUserInfoParams {
-	/** The nickname. */
-	nickname?: string;
-	/** The avatar URL. */
-	avatarurl?: string;
-	/** The email address. */
-	mail?: string;
-	/** The phone number. */
-	phone?: string;
-	/** Gender. You can define it with the following type: string, number, boolean. */
-	gender?: string | number | boolean;
-	/** Signature. */
-	sign?: string;
-	/** Birthday. */
-	birth?: string;
-	/** Extension. You can define it with the following type: string, number, boolean. */
-	ext?: string;
-}
-/** Configurable fields. */
-declare type ConfigurableKey =
-	| 'nickname'
-	| 'avatarurl'
-	| 'mail'
-	| 'phone'
-	| 'gender'
-	| 'sign'
-	| 'birth'
-	| 'ext';
-interface RosterData {
-	name: string;
-	subscription: 'both';
-	jid: Jid;
-}
-interface BaseUserInfo {
-	/** Whether the current user is enabled. - `true`: Yes; - `false`: No.*/
-	activated: boolean;
-	/** The timestamp when the current user is created. */
-	created: number;
-	/** The time when the user information is last modified. */
-	modified: number;
-	/** The display name in the message push notification. */
-	nickname: string;
-	/** The user type. */
-	type: string;
-	/** The user ID. */
-	username: string;
-	/** The user uuid on the server. */
-	uuid: string;
-}
-export interface PushInfo {
-	/** The device ID, used to identify a device, which can be customized.*/
-	device_id: string;
-	/** The push token, which can be defined by yourself, is generally used to identify the same device. */
-	device_token: string;
-	/** The Push service appId, senderID for FCM, "appId+#+AppKey" for Vivo */
-	notifier_name: string;
-}
-interface UploadTokenResult extends BaseUserInfo {
-	/** The push information. */
-	pushInfo: PushInfo[];
-}
-interface SessionInfo {
-	/** The conversation ID. */
-	channel_id: string;
-	/** The content of the last message.*/
-	meta: {
-		/** The message sender. */
-		from: string;
-		/** The message ID. */
-		id: string;
-		/** The message content. */
-		payload: string;
-		/** The time when the message is received. */
-		timestamp: number;
-		/** The message recipient. */
-		to: string;
-	};
-	/** The number of unread messages. */
-	unread_num: number;
-}
-interface ConversationList {
-	/** The conversation ID. */
-	channel_id: string;
-	/** Overview of the latest news. */
-	lastMessage: MessageBody | Record<string, never>;
-	/** The number of unread messages. */
-	unread_num: number;
-}
-interface ConversationInfo {
-	/** The conversation list. */
-	channel_infos: ConversationList[];
-}
-interface DeleteSessionResult {
-	/** The result of request. */
-	result: 'ok';
-}
-interface SendMsgResult {
-	/** The local ID of the message. */
-	localMsgId: string;
-	/** The message ID on the server. */
-	serverMsgId: string;
-	/** Message. */
-	message?: ExcludeAckMessageBody;
-}
-
-interface ModifyMsgResult extends SendMsgResult {
-	/** The modified info of the message. */
-	modifiedInfo: ModifiedMsgInfo;
-}
-interface HistoryMessages {
-	/** The starting message ID for the next query. If the number of messages returned by the SDK is smaller than the requested number, the cursor will be `undefined`. */
-	cursor?: string;
-	/** The historical messages. */
-	messages: MessagesType[];
-	/** Whether it is the last page of data.
-	 *  - `true`: Yes;
-	 *  - `false`: No.
-	 * If the number of data entries is smaller than the message count set in the request, `false` is returned; otherwise, `true` is returned.
-	 */
-	isLast: boolean;
-}
-
-/**
- * The multiple-keyword match type for server message search.
- * `or` means any keyword can match, and `and` means all keywords must match.
- * 服务端消息搜索的多关键词匹配关系。
- * `or` 表示命中任意关键词即可，`and` 表示必须命中全部关键词。
- */
-type MessageSearchKeywordListMatchType = 'or' | 'and';
-
-/**
- * The search scope for server message search.
- * `none` searches only the message body, `with` searches both body and extensions,
- * and `only` searches only extension fields.
- * 服务端消息搜索范围。
- * `none` 仅搜索消息体，`with` 同时搜索消息体和扩展字段，
- * `only` 仅搜索扩展字段。
- */
-type MessageSearchScope = 'none' | 'with' | 'only';
-
-/**
- * A WebSDK message object mapped from one server-side search hit.
- * 由单条服务端搜索命中结果映射得到的 WebSDK 消息对象。
- */
-type ServerSearchMessage = ExcludeAckMessageBody & {
-	/** The conversation ID of the matched message. */
-	/** 命中消息所属的会话 ID。 */
-	conversationId?: string;
-	/** Highlight fragments returned by the server. */
-	/** 服务端返回的高亮片段。 */
-	highlight?: string[];
-	/** Summary text returned by the server for quick display. */
-	/** 服务端返回的摘要文本，用于快速展示。 */
-	text?: string;
-};
-
-/**
- * The paged result returned by server-side message search.
- * 服务端消息搜索返回的分页结果。
- */
-interface ServerSearchMessagesResult {
-	/** The server search result messages. */
-	/** 服务端搜索结果消息列表。 */
-	messages: ServerSearchMessage[];
-	/** The current page number. */
-	/** 当前页码。 */
-	pageNum: number;
-	/** The requested page size echoed by the SDK. */
-	/** SDK 回填的请求页大小。 */
-	pageSize: number;
-	/** The total number of pages. */
-	/** 总页数。 */
-	totalPages: number;
-	/** Whether the current page is the last page. */
-	/** 当前页是否为最后一页。 */
-	isLast: boolean;
-	/** The request trace id returned by the server. */
-	/** 服务端返回的请求追踪 ID。 */
-	requestId?: string;
-	/** The server response timestamp in milliseconds. */
-	/** 服务端响应时间戳，单位为毫秒。 */
-	timestamp: number;
-}
-
-/**
- * The options for server-side message search.
- * 用于配置服务端消息搜索请求的参数集合。
- */
-interface MessageSearchOption {
-	/** The keyword list for search. */
-	/** 搜索关键词列表。 */
-	keywordList: string[];
-	/** The keyword list match type. The valid values are `or` and `and`. The default value is `or`. */
-	/** 多关键词匹配关系，可选值为 `or` 和 `and`。默认值为 `or`。 */
-	keywordListMatchType?: MessageSearchKeywordListMatchType;
-	/** The conversation ID for in-conversation search. */
-	/** 会话内搜索时的会话 ID。 */
-	conversationId?: string;
-	/** The conversation type for filtering. Must be used with conversationId. */
-	/** 会话类型过滤。需要与 conversationId 配合使用。 */
-	conversationType?: ChatType;
-	/** Message body type filters. */
-	/** 消息体类型过滤。 */
-	msgTypes?: MessageType[];
-	/** The start timestamp for query. The unit is millisecond. */
-	/** 查询开始时间戳，单位为毫秒。 */
-	startTime?: number;
-	/** The end timestamp for query. The unit is millisecond. */
-	/** 查询结束时间戳，单位为毫秒。 */
-	endTime?: number;
-	/** The search scope. */
-	/** 搜索范围。 */
-	searchScope?: MessageSearchScope;
-}
-
-interface ServerConversations {
-	/** The conversation list. */
-	conversations: ConversationItem[];
-	/** The position from which to start getting data for the next query. If the number of returned data entries is smaller than that specified in the request, the cursor is an empty string (''), which indicates that the current page is the last page; otherwise, the SDK returns the specific cursor position which indicates where to start getting data for the next query.*/
-	cursor: string;
-}
-
-interface ConversationItem {
-	/** The conversation ID. */
-	conversationId: string;
-	/** The conversation type. */
-	conversationType: 'singleChat' | 'groupChat';
-	/** Whether the conversation is pinned. `true`:pinned; `false`: unpinned. */
-	isPinned: boolean;
-	/** The UNIX timestamp when the conversation is pinned. The unit is millisecond. This value is `0` when conversation is not pinned. */
-	pinnedTime: number;
-	/** Overview of the latest message. */
-	lastMessage: MessageBody | Record<string, never> | null;
-	/** The number of unread messages. */
-	unReadCount: number;
-	/** The conversation marks. */
-	marks?: Array<MarkType>;
-}
-interface PinConversation {
-	/** Whether the conversation is pinned. `true`: pinned; `false`: unpinned.*/
-	isPinned: boolean;
-	/** The UNIX timestamp when the conversation is pinned. The unit is millisecond. This value is `0` when the conversation is not pinned. */
-	pinnedTime: number;
-}
-
-interface ContactItem {
-	/** The user ID. */
-	userId: UserId;
-	/** The user remark. */
-	remark: string;
-}
-
-interface CursorContactsResult {
-	/** The position from which to start getting data for the next query. If the number of returned data entries is smaller than that specified in the request, the cursor is an empty string (''), which indicates that the current page is the last page; otherwise, the SDK returns the specific cursor position which indicates where to start getting data for the next query.*/
-	cursor?: string;
-	/** The contact list. */
-	contacts: ContactItem[];
-}
-
-interface AudioParams {
-	/** The audio format. */
-	format?: string;
-	/** The sample rate. */
-	sampleRate?: number;
-	/** The bits per sample. */
-	bitsPerSample?: number;
-	/** The number of channels. */
-	channels?: number;
-}
-
-interface MiniProgramVoiceFile {
-	/** The local file path in mini program. */
-	filePath: string;
-	/** The optional file name. */
-	name?: string;
-	/** The optional file size in bytes. */
-	size?: number;
-}
-
-type VoiceSourceFile = File | MiniProgramVoiceFile;
-
-interface OperateResult {
-	/** The userIds of the operation successfully. */
-	userIds: UserId[];
-}
-
-/** The conversation mark types. The mapping between each type of conversation mark and their actual meanings is maintained by the developer. */
-declare enum MarkType {
-	mark_0,
-	mark_1,
-	mark_2,
-	mark_3,
-	mark_4,
-	mark_5,
-	mark_6,
-	mark_7,
-	mark_8,
-	mark_9,
-	mark_10,
-	mark_11,
-	mark_12,
-	mark_13,
-	mark_14,
-	mark_15,
-	mark_16,
-	mark_17,
-	mark_18,
-	mark_19,
-}
-
-interface PinnedMessageInfo {
-	/** The pinned message. */
-	message: MessagesType;
-	/** When the message is pinned. The unit is millisecond.  */
-	pinTime: number;
-	/** The user ID of the operator that pins the message. */
-	operatorId: UserId;
-}
-interface CursorPinnedMessagesResult {
-	/** The position from which to start getting data for the next query. If the number of returned data entries is smaller than that specified in the request, the cursor is an empty string (''), which indicates that the current page is the last page; otherwise, the SDK returns the specific cursor position which indicates where to start getting data for the next query.*/
-	cursor: string;
-	/** The list of pinned messages. */
-	list: PinnedMessageInfo[];
-}
-
-export type {
-	UploadTokenResult,
-	SessionInfo,
-	ConversationList,
-	BaseUserInfo,
-	DeleteSessionResult,
-	SendMsgResult,
-	ConversationInfo,
-	ServerConversations,
-	ConversationItem,
-	PinConversation,
-	ContactItem,
-	CursorContactsResult,
-	AudioParams,
-	MiniProgramVoiceFile,
-	VoiceSourceFile,
-	OperateResult,
-	MarkType,
-	CursorPinnedMessagesResult,
-};
-export type {
-	RosterData,
-	UpdateOwnUserInfoParams,
-	ConfigurableKey,
-	HistoryMessages,
-	ModifyMsgResult,
-	MessageSearchKeywordListMatchType,
-	MessageSearchScope,
-	ServerSearchMessage,
-	ServerSearchMessagesResult,
-	MessageSearchOption,
-};