Methods
(async, static) createMeeting(param0) → {string}
Parameters:
| Name |
Type |
Description |
param0 |
Object
|
Properties
| Name |
Type |
Attributes |
Default |
Description |
title |
string
|
<optional>
|
""
|
meeting title. |
isTemporary |
boolean
|
<optional>
|
false
|
meeting won't be saved in dashboard. |
capacity |
Number
|
<optional>
|
2
|
1 or 2 , number of allowed stream to the meeting. |
meetingType |
Number
|
<optional>
|
0
|
0 DEFAULT or 1 WHITEBOARD |
|
- Source:
Returns:
- ID of created meeting
-
Type
-
string
(async, static) createShare(param0) → {string}
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Description |
email |
string
|
|
meetingId |
string
|
|
permission |
Number
|
1 Read or 2 Write. |
meetingToken |
string
|
|
|
- Source:
Returns:
-
Type
-
string
(static) createTemporaryShare(param0) → {string}
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Attributes |
Default |
Description |
meetingId |
string
|
|
|
meeting ID. |
permission |
Number
|
|
|
bitfield value (1 ImageRead, 2 ImageWrite, 4 AnnotationRead, 8 AnnotationWrite, 16 MeetingWrite) |
expiry |
Number
|
<optional>
|
3600
|
share time expiry in seconds. |
auxData |
object
|
<optional>
|
{}
|
object that can be used to include specific data in meeting share like call ID for this share. |
|
- Source:
Returns:
- shareId
-
Type
-
string
(async, static) deleteMeeting(meetingId)
Parameters:
| Name |
Type |
Description |
meetingId |
string
|
|
- Source:
Returns:
- http response
(async, static) deleteMeetingImages(param0)
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Description |
meetingId |
string
|
|
mtoken |
string
|
|
|
- Source:
Returns:
- http response
(async, static) deleteShare(ID)
Delete a meeting share
Parameters:
| Name |
Type |
Description |
ID |
integer
|
of the share |
- Source:
Returns:
- http result
(async, static) endMeeting(param0)
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Description |
meetingId |
string
|
|
meetingToken |
string
|
|
|
- Source:
Returns:
- http response
(async, static) getIncomingShares() → {list}
- Source:
Returns:
a list of meetings shared with the current user
-
Type
-
list
(async, static) getMeetingDetails(meetingId) → {object}
Parameters:
| Name |
Type |
Description |
meetingId |
string
|
|
- Source:
Returns:
- object with meeting details.
-
Type
-
object
(async, static) getMeetingImage(param0) → {data}
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Description |
meetingId |
string
|
|
meetingToken |
string
|
|
imageId |
string
|
|
|
- Source:
Returns:
- base64 data
-
Type
-
data
(async, static) getMeetingImages(param0) → {Array}
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Description |
meetingId |
string
|
|
meetingToken |
string
|
|
|
- Source:
Returns:
- list of images
-
Type
-
Array
(async, static) getMeetingList(pagination) → {Array}
Parameters:
| Name |
Type |
Description |
pagination |
*
|
|
- Source:
Returns:
- meeting list.
-
Type
-
Array
(async, static) getMeetingToken(param0) → {string}
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Attributes |
Default |
Description |
meetingId |
string
|
|
|
|
permission |
Number
|
|
|
bitfield value (1 ImageRead, 2 ImageWrite, 4 AnnotationRead, 8 AnnotationWrite, 16 MeetingWrite) |
expiry |
Number
|
<optional>
|
3600
|
share time expiry in seconds. |
|
- Source:
Returns:
- token
-
Type
-
string
(async, static) getMeetingTokenFromTempShareId(param0) → {string}
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Description |
meetingId |
string
|
|
shareId |
string
|
|
|
- Source:
Returns:
- token
-
Type
-
string
(async, static) getOutgoingShares() → {list}
- Source:
Returns:
a list of meetings this user has shared with others
-
Type
-
list
(async, static) isMeetingOwner(meetingToken) → {Boolean}
Parameters:
| Name |
Type |
Description |
meetingToken |
string
|
|
- Source:
Returns:
-
Type
-
Boolean
(async, static) startMeeting(param0)
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Description |
meetingId |
string
|
|
meetingToken |
string
|
|
|
- Source:
Returns:
- http response
(async, static) updateMeeting(param0)
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Description |
meetingId |
string
|
|
title |
string
|
|
capacity |
Number
|
|
|
- Source:
Returns:
- http result
(async, static) updateShare(param0)
Update meeting share permission details
Parameters:
| Name |
Type |
Description |
param0 |
object
|
Properties
| Name |
Type |
Description |
shareId |
integer
|
|
permission |
string
|
|
|
- Source:
Returns:
- http result