@vonage/client-sdk 1.2.0-alpha.9 → 1.2.0-rc.1

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.
@@ -2,11 +2,21 @@ import './kotlin/clientsdk-clientcore_js';
2
2
  declare module './kotlin/clientsdk-clientcore_js' {
3
3
  namespace vonage {
4
4
  interface CombinedClientJS {
5
+ /**
6
+ * Set a configuration for the client SDK
7
+ *
8
+ * @example
9
+ * [[include: snippet_SetClientConfig.txt]]
10
+ *
11
+ * @param config - A configuration object
12
+ * @returns void
13
+ */
14
+ setConfig(config: ConfigObjectJS): void;
5
15
  /**
6
16
  * Mute your leg of a call
7
17
  *
8
18
  * @example
9
- * [[include:call_mute.txt]]
19
+ * [[include: snippet_CallMute.txt]]
10
20
  *
11
21
  * @param callId - Call ID
12
22
  * @returns void
@@ -24,7 +34,7 @@ declare module './kotlin/clientsdk-clientcore_js' {
24
34
  * Earmuff your leg of a call
25
35
  *
26
36
  * @example
27
- * [[include:earmuff_event.txt]]
37
+ * [[include: snippet_EarmuffEvent.txt]]
28
38
  *
29
39
  * @param callId - Call ID
30
40
  * @returns void
@@ -42,7 +52,7 @@ declare module './kotlin/clientsdk-clientcore_js' {
42
52
  * Send a string of digits to a call via DTMF
43
53
  *
44
54
  * @example
45
- * [[include:send_dtmf_digits.txt]]
55
+ * [[include: snippet_SendDtmfDigits.txt]]
46
56
  *
47
57
  * @param callId - Call ID
48
58
  * @param digits - DTMF digits
@@ -54,7 +64,7 @@ declare module './kotlin/clientsdk-clientcore_js' {
54
64
  * Answer a call
55
65
  *
56
66
  * @example
57
- * [[include:answer_call.txt]]
67
+ * [[include: snippet_AnswerCall.txt]]
58
68
  *
59
69
  * @param callId - Call ID
60
70
  * @returns void
@@ -65,7 +75,7 @@ declare module './kotlin/clientsdk-clientcore_js' {
65
75
  * Reject a call
66
76
  *
67
77
  * @example
68
- * [[include:reject_call.txt]]
78
+ * [[include: snippet_RejectCall.txt]]
69
79
  *
70
80
  * @param callId - Call ID
71
81
  * @returns void
@@ -76,7 +86,7 @@ declare module './kotlin/clientsdk-clientcore_js' {
76
86
  * Reconnect a call
77
87
  *
78
88
  * @example
79
- * [[include:reconnect_call.txt]]
89
+ * [[include: snippet_ReconnectCall.txt]]
80
90
  *
81
91
  * @param callId - Call ID
82
92
  * @returns void
@@ -0,0 +1,251 @@
1
+ import { vonage } from './clientsdk-clientcore_js';
2
+ /**
3
+ * The EmbeddedInfo type
4
+ *
5
+ * @property kind the kind property of the EmbeddedInfo
6
+ * @property memberId the memberId property of the EmbeddedInfo
7
+ * @property user the user property of the EmbeddedInfo
8
+ * @interface
9
+ */
10
+ export type EmbeddedInfo = {
11
+ kind: 'embeddedInfo';
12
+ } & vonage.EmbeddedInfoJS;
13
+ /**
14
+ * The System type
15
+ *
16
+ * @property kind the kind property of the System
17
+ * @interface
18
+ */
19
+ export type System = {
20
+ kind: 'system';
21
+ } & typeof vonage.SystemJS;
22
+ /**
23
+ * A From is a union of EmbeddedInfo, System
24
+ * @interface
25
+ */
26
+ export type From = EmbeddedInfo | System;
27
+ /**
28
+ * The EphemeralConversationEvent type
29
+ *
30
+ * @property kind the kind property of the EphemeralConversationEvent
31
+ * @property timestamp the timestamp property of the EphemeralConversationEvent
32
+ * @property conversationId the conversationId property of the EphemeralConversationEvent
33
+ * @property from the from property of the EphemeralConversationEvent
34
+ * @property body the body property of the EphemeralConversationEvent
35
+ * @interface
36
+ */
37
+ export type EphemeralConversationEvent = {
38
+ kind: 'ephemeral';
39
+ from: From;
40
+ } & vonage.EphemeralConversationEventJS;
41
+ /**
42
+ * A NonPersistentConversationEvent is a union of EphemeralConversationEvent
43
+ * @interface
44
+ */
45
+ export type NonPersistentConversationEvent = EphemeralConversationEvent;
46
+ /**
47
+ * The CustomConversationEvent type
48
+ *
49
+ * @property kind the kind property of the CustomConversationEvent
50
+ * @property id the id property of the CustomConversationEvent
51
+ * @property timestamp the timestamp property of the CustomConversationEvent
52
+ * @property conversationId the conversationId property of the CustomConversationEvent
53
+ * @property from the from property of the CustomConversationEvent
54
+ * @property eventType the eventType property of the CustomConversationEvent
55
+ * @property body the body property of the CustomConversationEvent
56
+ * @interface
57
+ */
58
+ export type CustomConversationEvent = {
59
+ kind: 'custom';
60
+ from: From;
61
+ } & vonage.CustomConversationEventJS;
62
+ /**
63
+ * The MemberInvitedEvent type
64
+ *
65
+ * @property kind the kind property of the MemberInvitedEvent
66
+ * @property id The event id
67
+ * @property timestamp The event timestamp
68
+ * @property conversationId The conversation id
69
+ * @property from The event sender
70
+ * @property body The invited member
71
+ * @interface
72
+ */
73
+ export type MemberInvitedEvent = {
74
+ kind: 'member:invited';
75
+ from: From;
76
+ } & vonage.MemberInvitedEventJS;
77
+ /**
78
+ * The MemberJoinedEvent type
79
+ *
80
+ * @property kind the kind property of the MemberJoinedEvent
81
+ * @property id the id property of the MemberJoinedEvent
82
+ * @property timestamp the timestamp property of the MemberJoinedEvent
83
+ * @property conversationId the conversationId property of the MemberJoinedEvent
84
+ * @property from the from property of the MemberJoinedEvent
85
+ * @property body the body property of the MemberJoinedEvent
86
+ * @interface
87
+ */
88
+ export type MemberJoinedEvent = {
89
+ kind: 'member:joined';
90
+ from: From;
91
+ } & vonage.MemberJoinedEventJS;
92
+ /**
93
+ * The MemberLeftEvent type
94
+ *
95
+ * @property kind the kind property of the MemberLeftEvent
96
+ * @property id the id property of the MemberLeftEvent
97
+ * @property timestamp the timestamp property of the MemberLeftEvent
98
+ * @property conversationId the conversationId property of the MemberLeftEvent
99
+ * @property from the from property of the MemberLeftEvent
100
+ * @property body the body property of the MemberLeftEvent
101
+ * @interface
102
+ */
103
+ export type MemberLeftEvent = {
104
+ kind: 'member:left';
105
+ from: From;
106
+ } & vonage.MemberLeftEventJS;
107
+ /**
108
+ * The MessageAudioEvent type
109
+ *
110
+ * @property kind the kind property of the MessageAudioEvent
111
+ * @property id the id property of the MessageAudioEvent
112
+ * @property timestamp the timestamp property of the MessageAudioEvent
113
+ * @property conversationId the conversationId property of the MessageAudioEvent
114
+ * @property from the from property of the MessageAudioEvent
115
+ * @property body the body property of the MessageAudioEvent
116
+ * @interface
117
+ */
118
+ export type MessageAudioEvent = {
119
+ kind: 'message:audio';
120
+ from: From;
121
+ } & vonage.MessageAudioEventJS;
122
+ /**
123
+ * The MessageCustomEvent type
124
+ *
125
+ * @property kind the kind property of the MessageCustomEvent
126
+ * @property id the id property of the MessageCustomEvent
127
+ * @property timestamp the timestamp property of the MessageCustomEvent
128
+ * @property conversationId the conversationId property of the MessageCustomEvent
129
+ * @property from the from property of the MessageCustomEvent
130
+ * @property body the body property of the MessageCustomEvent
131
+ * @interface
132
+ */
133
+ export type MessageCustomEvent = {
134
+ kind: 'message:custom';
135
+ from: From;
136
+ } & vonage.MessageCustomEventJS;
137
+ /**
138
+ * The MessageFileEvent type
139
+ *
140
+ * @property kind the kind property of the MessageFileEvent
141
+ * @property id the id property of the MessageFileEvent
142
+ * @property timestamp the timestamp property of the MessageFileEvent
143
+ * @property conversationId the conversationId property of the MessageFileEvent
144
+ * @property from the from property of the MessageFileEvent
145
+ * @property body the body property of the MessageFileEvent
146
+ * @interface
147
+ */
148
+ export type MessageFileEvent = {
149
+ kind: 'message:file';
150
+ from: From;
151
+ } & vonage.MessageFileEventJS;
152
+ /**
153
+ * The MessageImageEvent type
154
+ *
155
+ * @property kind the kind property of the MessageImageEvent
156
+ * @property id the id property of the MessageImageEvent
157
+ * @property timestamp the timestamp property of the MessageImageEvent
158
+ * @property conversationId the conversationId property of the MessageImageEvent
159
+ * @property from the from property of the MessageImageEvent
160
+ * @property body the body property of the MessageImageEvent
161
+ * @interface
162
+ */
163
+ export type MessageImageEvent = {
164
+ kind: 'message:image';
165
+ from: From;
166
+ } & vonage.MessageImageEventJS;
167
+ /**
168
+ * The MessageLocationEvent type
169
+ *
170
+ * @property kind the kind property of the MessageLocationEvent
171
+ * @property id the id property of the MessageLocationEvent
172
+ * @property timestamp the timestamp property of the MessageLocationEvent
173
+ * @property conversationId the conversationId property of the MessageLocationEvent
174
+ * @property from the from property of the MessageLocationEvent
175
+ * @property body the body property of the MessageLocationEvent
176
+ * @interface
177
+ */
178
+ export type MessageLocationEvent = {
179
+ kind: 'message:location';
180
+ from: From;
181
+ } & vonage.MessageLocationEventJS;
182
+ /**
183
+ * The MessageTemplateEvent type
184
+ *
185
+ * @property kind the kind property of the MessageTemplateEvent
186
+ * @property id the id property of the MessageTemplateEvent
187
+ * @property timestamp the timestamp property of the MessageTemplateEvent
188
+ * @property conversationId the conversationId property of the MessageTemplateEvent
189
+ * @property from the from property of the MessageTemplateEvent
190
+ * @property body the body property of the MessageTemplateEvent
191
+ * @interface
192
+ */
193
+ export type MessageTemplateEvent = {
194
+ kind: 'message:template';
195
+ from: From;
196
+ } & vonage.MessageTemplateEventJS;
197
+ /**
198
+ * The MessageTextEvent type
199
+ *
200
+ * @property kind the kind property of the MessageTextEvent
201
+ * @property id the id property of the MessageTextEvent
202
+ * @property timestamp the timestamp property of the MessageTextEvent
203
+ * @property conversationId the conversationId property of the MessageTextEvent
204
+ * @property from the from property of the MessageTextEvent
205
+ * @property body the body property of the MessageTextEvent
206
+ * @interface
207
+ */
208
+ export type MessageTextEvent = {
209
+ kind: 'message:text';
210
+ from: From;
211
+ } & vonage.MessageTextEventJS;
212
+ /**
213
+ * The MessageVCardEvent type
214
+ *
215
+ * @property kind the kind property of the MessageVCardEvent
216
+ * @property id the id property of the MessageVCardEvent
217
+ * @property timestamp the timestamp property of the MessageVCardEvent
218
+ * @property conversationId the conversationId property of the MessageVCardEvent
219
+ * @property from the from property of the MessageVCardEvent
220
+ * @property body the body property of the MessageVCardEvent
221
+ * @interface
222
+ */
223
+ export type MessageVCardEvent = {
224
+ kind: 'message:vcard';
225
+ from: From;
226
+ } & vonage.MessageVCardEventJS;
227
+ /**
228
+ * The MessageVideoEvent type
229
+ *
230
+ * @property kind the kind property of the MessageVideoEvent
231
+ * @property id the id property of the MessageVideoEvent
232
+ * @property timestamp the timestamp property of the MessageVideoEvent
233
+ * @property conversationId the conversationId property of the MessageVideoEvent
234
+ * @property from the from property of the MessageVideoEvent
235
+ * @property body the body property of the MessageVideoEvent
236
+ * @interface
237
+ */
238
+ export type MessageVideoEvent = {
239
+ kind: 'message:video';
240
+ from: From;
241
+ } & vonage.MessageVideoEventJS;
242
+ /**
243
+ * A PersistentConversationEvent is a union of CustomConversationEvent, MemberInvitedEvent, MemberJoinedEvent, MemberLeftEvent, MessageAudioEvent, MessageCustomEvent, MessageFileEvent, MessageImageEvent, MessageLocationEvent, MessageTemplateEvent, MessageTextEvent, MessageVCardEvent, MessageVideoEvent
244
+ * @interface
245
+ */
246
+ export type PersistentConversationEvent = CustomConversationEvent | MemberInvitedEvent | MemberJoinedEvent | MemberLeftEvent | MessageAudioEvent | MessageCustomEvent | MessageFileEvent | MessageImageEvent | MessageLocationEvent | MessageTemplateEvent | MessageTextEvent | MessageVCardEvent | MessageVideoEvent;
247
+ /**
248
+ * A ConversationEvent is a union of NonPersistentConversationEventJS, PersistentConversationEventJS
249
+ * @interface
250
+ */
251
+ export type ConversationEvent = NonPersistentConversationEvent | PersistentConversationEvent;