easemob-websdk 4.1.4-beta2 → 4.1.4

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.
Files changed (17) hide show
  1. package/Easemob-chat.d.ts +142 -9
  2. package/Easemob-chat.js +1 -1
  3. package/message/audio.d.ts +8 -2
  4. package/message/channel.d.ts +8 -2
  5. package/message/cmd.d.ts +8 -2
  6. package/message/custom.d.ts +8 -2
  7. package/message/delivery.d.ts +8 -2
  8. package/message/file.d.ts +8 -2
  9. package/message/img.d.ts +8 -2
  10. package/message/location.d.ts +8 -2
  11. package/message/read.d.ts +8 -2
  12. package/message/text.d.ts +8 -2
  13. package/message/video.d.ts +8 -2
  14. package/miniCore/miniCore.js +1 -1
  15. package/miniProgram/Easemob-chat.js +1 -1
  16. package/package.json +1 -1
  17. package/uniApp/Easemob-chat.js +1 -1
package/message/audio.d.ts CHANGED
@@ -86,7 +86,10 @@ export interface AudioMsgBody extends AudioMsgSetParameters {
86
86
  isChatThread?: boolean;
87
87
  /** Message priority. */
88
88
  priority?: MessagePriority;
89
- /** Whether the message is delivered online only. */
89
+ /** Whether the message is delivered only when the recipient(s) is/are online:
90
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
91
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
92
+ */
90
93
  deliverOnlineOnly?: boolean;
91
94
  }
92
95
  export interface CreateAudioMsgParameters {
@@ -135,7 +138,10 @@ export interface CreateAudioMsgParameters {
135
138
  isChatThread?: boolean;
136
139
  /** Message priority. */
137
140
  priority?: MessagePriority;
138
- /** Whether the message is delivered online only. */
141
+ /** Whether the message is delivered only when the recipient(s) is/are online:
142
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
143
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
144
+ */
139
145
  deliverOnlineOnly?: boolean;
140
146
  }
141
147
  export declare class Audio {
package/message/channel.d.ts CHANGED
@@ -30,7 +30,10 @@ export interface ChannelMsgBody extends ChannelMsgSetParameters {
30
30
  isChatThread?: boolean;
31
31
  /** Message priority. */
32
32
  priority?: MessagePriority;
33
- /** Whether the message is delivered online only. */
33
+ /** Whether the message is delivered only when the recipient(s) is/are online:
34
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
35
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
36
+ */
34
37
  deliverOnlineOnly?: boolean;
35
38
  }
36
39
  export interface ChannelParameters {
@@ -52,7 +55,10 @@ export interface CreateChannelMsgParameters {
52
55
  isChatThread?: boolean;
53
56
  /** Message priority. */
54
57
  priority?: MessagePriority;
55
- /** Whether the message is delivered online only. */
58
+ /** Whether the message is delivered only when the recipient(s) is/are online:
59
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
60
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
61
+ */
56
62
  deliverOnlineOnly?: boolean;
57
63
  }
58
64
  export declare class Channel {
package/message/cmd.d.ts CHANGED
@@ -71,7 +71,10 @@ export interface CmdMsgBody {
71
71
  isChatThread?: boolean;
72
72
  /** Message priority. */
73
73
  priority?: MessagePriority;
74
- /** Whether the message is delivered online only. */
74
+ /** Whether the message is delivered only when the recipient(s) is/are online:
75
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
76
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
77
+ */
75
78
  deliverOnlineOnly?: boolean;
76
79
  }
77
80
  export interface CreateCmdMsgParameters {
@@ -97,7 +100,10 @@ export interface CreateCmdMsgParameters {
97
100
  isChatThread?: boolean;
98
101
  /** Message priority. */
99
102
  priority?: MessagePriority;
100
- /** Whether the message is delivered online only. */
103
+ /** Whether the message is delivered only when the recipient(s) is/are online:
104
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
105
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
106
+ */
101
107
  deliverOnlineOnly?: boolean;
102
108
  }
103
109
  export declare class Cmd {
package/message/custom.d.ts CHANGED
@@ -58,7 +58,10 @@ export interface CustomMsgBody extends CreateCustomMsgParameters {
58
58
  time: number;
59
59
  /** Message priority. */
60
60
  priority?: MessagePriority;
61
- /** Whether the message is delivered online only. */
61
+ /** Whether the message is delivered only when the recipient(s) is/are online:
62
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
63
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
64
+ */
62
65
  deliverOnlineOnly?: boolean;
63
66
  }
64
67
  export interface CreateCustomMsgParameters {
@@ -88,7 +91,10 @@ export interface CreateCustomMsgParameters {
88
91
  isChatThread?: boolean;
89
92
  /** Message priority. */
90
93
  priority?: MessagePriority;
91
- /** Whether the message is delivered online only. */
94
+ /** Whether the message is delivered only when the recipient(s) is/are online:
95
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
96
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
97
+ */
92
98
  deliverOnlineOnly?: boolean;
93
99
  }
94
100
  export declare class Custom {
package/message/delivery.d.ts CHANGED
@@ -39,7 +39,10 @@ export interface DeliveryMsgBody {
39
39
  isChatThread?: boolean;
40
40
  /** Message priority. */
41
41
  priority?: MessagePriority;
42
- /** Whether the message is delivered online only. */
42
+ /** Whether the message is delivered only when the recipient(s) is/are online:
43
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
44
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
45
+ */
43
46
  deliverOnlineOnly?: boolean;
44
47
  }
45
48
  export interface CreateDeliveryMsgParameters {
@@ -55,7 +58,10 @@ export interface CreateDeliveryMsgParameters {
55
58
  isChatThread?: boolean;
56
59
  /** Message priority. */
57
60
  priority?: MessagePriority;
58
- /** Whether the message is delivered online only. */
61
+ /** Whether the message is delivered only when the recipient(s) is/are online:
62
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
63
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
64
+ */
59
65
  deliverOnlineOnly?: boolean;
60
66
  }
61
67
  export declare class Delivery {
package/message/file.d.ts CHANGED
@@ -83,7 +83,10 @@ export interface FileMsgBody extends CreateFileMsgParameters {
83
83
  };
84
84
  /** Message priority. */
85
85
  priority?: MessagePriority;
86
- /** Whether the message is delivered online only. */
86
+ /** Whether the message is delivered only when the recipient(s) is/are online:
87
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
88
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
89
+ */
87
90
  deliverOnlineOnly?: boolean;
88
91
  }
89
92
  export interface CreateFileMsgParameters {
@@ -128,7 +131,10 @@ export interface CreateFileMsgParameters {
128
131
  isChatThread?: boolean;
129
132
  /** Message priority. */
130
133
  priority?: MessagePriority;
131
- /** Whether the message is delivered online only. */
134
+ /** Whether the message is delivered only when the recipient(s) is/are online:
135
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
136
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
137
+ */
132
138
  deliverOnlineOnly?: boolean;
133
139
  }
134
140
  export declare class FileMsg {
package/message/img.d.ts CHANGED
@@ -96,7 +96,10 @@ export interface ImgMsgBody extends CreateImgMsgParameters {
96
96
  fail?: () => void;
97
97
  /** Message priority. */
98
98
  priority?: MessagePriority;
99
- /** Whether the message is delivered online only. */
99
+ /** Whether the message is delivered only when the recipient(s) is/are online:
100
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
101
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
102
+ */
100
103
  deliverOnlineOnly?: boolean;
101
104
  }
102
105
  export interface CreateImgMsgParameters {
@@ -143,7 +146,10 @@ export interface CreateImgMsgParameters {
143
146
  isChatThread?: boolean;
144
147
  /** Message priority. */
145
148
  priority?: MessagePriority;
146
- /** Whether the message is delivered online only. */
149
+ /** Whether the message is delivered only when the recipient(s) is/are online:
150
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
151
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
152
+ */
147
153
  deliverOnlineOnly?: boolean;
148
154
  }
149
155
  export declare class Img {
package/message/location.d.ts CHANGED
@@ -59,7 +59,10 @@ export interface LocationMsgBody extends CreateLocationMsgParameters {
59
59
  time: number;
60
60
  /** Message priority. */
61
61
  priority?: MessagePriority;
62
- /** Whether the message is delivered online only. */
62
+ /** Whether the message is delivered only when the recipient(s) is/are online:
63
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
64
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
65
+ */
63
66
  deliverOnlineOnly?: boolean;
64
67
  }
65
68
  export interface CreateLocationMsgParameters {
@@ -91,7 +94,10 @@ export interface CreateLocationMsgParameters {
91
94
  isChatThread?: boolean;
92
95
  /** Message priority. */
93
96
  priority?: MessagePriority;
94
- /** Whether the message is delivered online only. */
97
+ /** Whether the message is delivered only when the recipient(s) is/are online:
98
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
99
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
100
+ */
95
101
  deliverOnlineOnly?: boolean;
96
102
  }
97
103
  export declare class Location {
package/message/read.d.ts CHANGED
@@ -37,7 +37,10 @@ export interface ReadMsgBody extends ReadMsgSetParameters {
37
37
  isChatThread?: boolean;
38
38
  /** Message priority. */
39
39
  priority?: MessagePriority;
40
- /** Whether the message is delivered online only. */
40
+ /** Whether the message is delivered only when the recipient(s) is/are online:
41
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
42
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
43
+ */
41
44
  deliverOnlineOnly?: boolean;
42
45
  }
43
46
  export interface ReadParameters {
@@ -63,7 +66,10 @@ export interface CreateReadMsgParameters {
63
66
  isChatThread?: boolean;
64
67
  /** Message priority. */
65
68
  priority?: MessagePriority;
66
- /** Whether the message is delivered online only. */
69
+ /** Whether the message is delivered only when the recipient(s) is/are online:
70
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
71
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
72
+ */
67
73
  deliverOnlineOnly?: boolean;
68
74
  }
69
75
  export declare class Read {
package/message/text.d.ts CHANGED
@@ -72,7 +72,10 @@ export interface TextMsgBody {
72
72
  isChatThread?: boolean;
73
73
  /** Message priority. */
74
74
  priority?: MessagePriority;
75
- /** Whether the message is delivered online only. */
75
+ /** Whether the message is delivered only when the recipient(s) is/are online:
76
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
77
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
78
+ */
76
79
  deliverOnlineOnly?: boolean;
77
80
  }
78
81
  export interface CreateTextMsgParameters {
@@ -99,7 +102,10 @@ export interface CreateTextMsgParameters {
99
102
  isChatThread?: boolean;
100
103
  /** Message priority. */
101
104
  priority?: MessagePriority;
102
- /** Whether the message is delivered online only. */
105
+ /** Whether the message is delivered only when the recipient(s) is/are online:
106
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
107
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
108
+ */
103
109
  deliverOnlineOnly?: boolean;
104
110
  }
105
111
  export declare class Text {
package/message/video.d.ts CHANGED
@@ -84,7 +84,10 @@ export interface VideoMsgBody extends VideoMsgSetParameters {
84
84
  isChatThread?: boolean;
85
85
  /** Message priority. */
86
86
  priority?: MessagePriority;
87
- /** Whether the message is delivered online only. */
87
+ /** Whether the message is delivered only when the recipient(s) is/are online:
88
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
89
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
90
+ */
88
91
  deliverOnlineOnly?: boolean;
89
92
  }
90
93
  export interface CreateVideoMsgParameters {
@@ -133,7 +136,10 @@ export interface CreateVideoMsgParameters {
133
136
  isChatThread?: boolean;
134
137
  /** Message priority. */
135
138
  priority?: MessagePriority;
136
- /** Whether the message is delivered online only. */
139
+ /** Whether the message is delivered only when the recipient(s) is/are online:
140
+ * - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is not delivered.
141
+ * - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
142
+ */
137
143
  deliverOnlineOnly?: boolean;
138
144
  }
139
145
  export declare class Video {