easemob-websdk 4.1.3 → 4.1.4-beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Easemob-chat.d.ts +1 -1
- package/Easemob-chat.js +1 -1
- package/category/category.d.ts +121 -0
- package/category/category.js +1 -0
- package/channel/channel.d.ts +346 -0
- package/channel/channel.js +1 -0
- package/circleSdk/Easemob-chat.d.ts +7899 -0
- package/circleSdk/Easemob-chat.js +1 -0
- package/package.json +1 -1
- package/readme.md +4 -0
- package/server/server.d.ts +318 -0
- package/server/server.js +1 -0
- package/types/categoryApi.d.ts +50 -0
- package/types/channelApi.d.ts +162 -0
- package/types/common.d.ts +5 -0
- package/types/indexApi.d.ts +2 -3
- package/types/serverApi.d.ts +123 -0
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
interface ServerInfo {
|
|
2
|
+
/** The server ID. */
|
|
3
|
+
id: string;
|
|
4
|
+
/** The server name. */
|
|
5
|
+
name: string;
|
|
6
|
+
/** The server icon. */
|
|
7
|
+
icon: string;
|
|
8
|
+
/** The ID of the default channel. */
|
|
9
|
+
defaultChannelId: string;
|
|
10
|
+
/** The server owner. */
|
|
11
|
+
owner: string;
|
|
12
|
+
/** The server description. */
|
|
13
|
+
description: string;
|
|
14
|
+
/** The tags list of the server. */
|
|
15
|
+
tags?: ServerTag[];
|
|
16
|
+
/** The server extension field. */
|
|
17
|
+
ext: string;
|
|
18
|
+
/** The UNIX timestamp when the server was created. The unit is millisecond. */
|
|
19
|
+
created?: number;
|
|
20
|
+
/** Whether it is a public server.
|
|
21
|
+
* - `true`: Yes.
|
|
22
|
+
* - `false`: No.
|
|
23
|
+
*/
|
|
24
|
+
isPublic: boolean;
|
|
25
|
+
/** The server background. */
|
|
26
|
+
backgroundUrl: string;
|
|
27
|
+
}
|
|
28
|
+
interface ServerInfoList {
|
|
29
|
+
/** The serer information list */
|
|
30
|
+
list: ServerInfo[];
|
|
31
|
+
/** The position from which to start getting data. If you set `cursor` to an empty string at the first method call, the SDK retrieves servers in the chronological order of when they were created.*/
|
|
32
|
+
cursor: string;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
interface ServerMember {
|
|
36
|
+
/** The user ID of the server member. */
|
|
37
|
+
userId: string;
|
|
38
|
+
/** The role of the member in the server. */
|
|
39
|
+
role: RoleType;
|
|
40
|
+
}
|
|
41
|
+
interface ServerMemberData {
|
|
42
|
+
/** The server member list. */
|
|
43
|
+
list: ServerMember[];
|
|
44
|
+
/** The position from which to start getting data. If you set `cursor` to an empty string at the first method call, the SDK retrieves channels in the chronological order of when they were created.*/
|
|
45
|
+
cursor?: string;
|
|
46
|
+
}
|
|
47
|
+
interface ServerRole {
|
|
48
|
+
role: RoleType;
|
|
49
|
+
}
|
|
50
|
+
type RoleType = 'owner' | 'moderator' | 'user';
|
|
51
|
+
|
|
52
|
+
interface ServerTag {
|
|
53
|
+
/** The server tag ID. */
|
|
54
|
+
tagId: string;
|
|
55
|
+
/** The server tag name. */
|
|
56
|
+
tagName: string;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
interface ServerTagList {
|
|
60
|
+
/** The server tag list. */
|
|
61
|
+
tags: ServerTag[];
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
type ServerChangeType =
|
|
65
|
+
| 'create'
|
|
66
|
+
| 'update'
|
|
67
|
+
| 'destroy'
|
|
68
|
+
| 'memberPresence'
|
|
69
|
+
| 'memberAbsence'
|
|
70
|
+
| 'inviteToJoin'
|
|
71
|
+
| 'acceptInvite'
|
|
72
|
+
| 'refuseInvite'
|
|
73
|
+
| 'removed'
|
|
74
|
+
| 'updateRole';
|
|
75
|
+
|
|
76
|
+
interface ServerChangeInfo {
|
|
77
|
+
/** The server ID. */
|
|
78
|
+
serverId: string;
|
|
79
|
+
/** The operation type. */
|
|
80
|
+
operation: ServerChangeType;
|
|
81
|
+
/** The operator. */
|
|
82
|
+
operator: string;
|
|
83
|
+
/** The server owner. */
|
|
84
|
+
owner?: string;
|
|
85
|
+
/** The UNIX timestamp when the event occurs. The unit is millisecond. */
|
|
86
|
+
timestamp: number;
|
|
87
|
+
/** The user ID of the operated member. */
|
|
88
|
+
userId?: string;
|
|
89
|
+
/** The user ID of the operated member. */
|
|
90
|
+
userIds?: string[];
|
|
91
|
+
/** The role of the member in the server. */
|
|
92
|
+
role?: string;
|
|
93
|
+
/** The server name. */
|
|
94
|
+
name?: string;
|
|
95
|
+
/** The server description. */
|
|
96
|
+
description?: string;
|
|
97
|
+
/** The server extension field. */
|
|
98
|
+
ext?: string;
|
|
99
|
+
/** The server icon. */
|
|
100
|
+
icon?: string;
|
|
101
|
+
/** Whether it is a public server.
|
|
102
|
+
* - `true`: Public server
|
|
103
|
+
* - `false`: Private server
|
|
104
|
+
*/
|
|
105
|
+
isPublic?: boolean;
|
|
106
|
+
/** The server background. */
|
|
107
|
+
backgroundUrl?: string;
|
|
108
|
+
/** The ID of the default channel. */
|
|
109
|
+
defaultChannelId?: string;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export type {
|
|
113
|
+
ServerInfo,
|
|
114
|
+
ServerInfoList,
|
|
115
|
+
ServerMember,
|
|
116
|
+
ServerMemberData,
|
|
117
|
+
ServerRole,
|
|
118
|
+
ServerTag,
|
|
119
|
+
ServerTagList,
|
|
120
|
+
ServerChangeType,
|
|
121
|
+
ServerChangeInfo,
|
|
122
|
+
RoleType,
|
|
123
|
+
};
|