Room
Create Room
Input params:RoomCreateOptions
Name | Type | Description | Required |
---|---|---|---|
name | string | room name | true |
invitedUserIds | string array | array of user ids to invite | false |
Output params:
Name | Type | Description | Required |
---|---|---|---|
CreateRoomResponse.RoomId | string | id of the new room | true |
Invite User
Input params:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
userId | string | user id | true |
Output params: none
Kick User
Input params:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
userId | string | user id | true |
Return values: none
Join Room
Input params:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
Output params:
Name | Type | Description | Required |
---|---|---|---|
JoinRoomResponse.RoomId | string | room id | true |
Leave Room
Input params:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
Output params: none
Get Room Memebers
Input params:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
Output params:
Name | Type | Description | Required |
---|---|---|---|
RoomMembersResponse.joined | array of MemberInfo | room members | true |
MemberInfo:
Name | Type | Description | Required |
---|---|---|---|
MemberInfo.DisplayName | string | member display name | true |
MemberInfo.AvatarUrl | string | member avatar url | true |
Last updated