The PimentaCall Schema
The object for manage calls in pimentaCHAT
| Field | Type | Description |
|---|---|---|
| userId | String |
The user that start the call |
| to | Array |
A array with the recipient users |
| channel | String |
The URL of pimentaLIVE room |
| date | Date |
The date of creation of call on startCall() method |
| isGroup | Boolean |
Indicate if call is from a group or individual |
| waiting | Boolean |
Indicate if a call is waiting for response from some user. This value is false only when ALL users responds or timeout on calls |
| accepted | Boolean |
Indicate that a call is accepted if at least one user accepts |
| missed | Boolean |
Indicate if a call was missed, not started by any reason |
| senderName | String |
The name of user that starts the call |
| senderGroup | String |
The name of group that call was started, if isGroup is true |
| onlyAudio | Boolean |
Indicate if the call is a video or audio call |
| roomId | String |
The roomId if is a Group call |
| log | Object |
This object contains info about startDate, endDate and ping for each participant of call. This object is indexed by userId. Example: {"5vopq6R99CXT2zY6B": {"startDate": "2019-08-22T18:22:25.783Z", "endDate": "2019-08-22T18:22:25.783Z", "ping": "2019-08-22T18:22:25.783Z"}} |
| participants | int |
(deprecated) The number of participants in the room |
| rejectCount | int |
(deprecated) The number of users rejected, theres no need of this field, because we get the value from rejectUsers.length |
| rejectUsers | Array |
A array with the user data (id, username and name) of users that reject the call |
| rejectUserIds | Array |
A array with the user ids of users that reject the call |
| acceptedUsers | Array |
A array with the user data (id, username and name) of users that accepts the call |
| acceptedUserIds | Array |
A array with the user ids of users that accepted the call |
| busyUsers | Array |
A array with the user data (id, username and name) of users that are in another call |
| busyUserIds | Array |
A array with the user ids of users that was in another the call |
| timeoutUsers | Array |
A array with the user data (id, username and name) of users that not responds to a call in a specific timeout interval |
| timeoutUserIds | Array |
A array with the user ids of users that timeout to receive the call |
| msgId | String |
The ID of message to present info about call |
| started | Date |
Contains the date that call was started (was accepted by some user). The default value is null |
| finished | Date |
Contains the date that call was finished. The default value is null |
| callerCancel | Boolean |
Is true when user that make the call cancel it before someone responds |
