Room
Create Room
Parameters:
Name | Type | Description | Required |
---|---|---|---|
name | string | room name | true |
isPublic | string | public or private | false |
invitees | string array | array of user ids to invite | false |
Returns:
Name | Type | Description | Required |
---|---|---|---|
room | Room | Room Object | true |
Join Room
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomIdOrAlias | string | room id or alias | true |
Returns:
Name | Type | Description | Required |
---|---|---|---|
room | Room | Room Object | true |
Get Room Object
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
Returns:
Name | Type | Description | Required |
---|---|---|---|
room | Room | Room Object | true |
Invite User
Parameters:
Name | Type | Description | Required |
---|---|---|---|
userId | string | user id | true |
Returns: none
Kick User
Parameters:
Name | Type | Description | Required |
---|---|---|---|
userId | string | user id | true |
Returns: none
Leave Room
input params:none
Returns: none
Get Room Memebers
Parameters: none
Returns:
Name | Type | Description | Required |
---|---|---|---|
roomMemberInfo | array of members | room member info | true |
Send Message
Parameters:
Name | Type | Description | Required |
---|---|---|---|
text | string | message to send | true |
Returns:
Name | Type | Description | Required |
---|---|---|---|
eventId | string | event id | true |
Last updated