Room
Create room
Parameters:
Name | Type | Description | Required |
---|---|---|---|
req.Name | string | room name | false |
req.RoomAliasName | string | room alias name | false |
req.Topic | string | room topic | false |
req.Invite | []string | a list of user IDs to invite to the room | false |
req.CreationContent | string | extra keys to be added to the content of the m.room.create event | false |
Returns:
Name | Type | Description | Required |
---|---|---|---|
resp.RoomID | string | id for the created room | true |
err | error | error message | true |
Join room
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomIDorAlias | string | room id or alias | true |
Returns:
Name | Type | Description | Required |
---|---|---|---|
resp.RoomID | string | id for the joined room | true |
err | error | error message | true |
Leave room
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomID | string | room id | true |
Returns:
Name | Type | Description | Required |
---|---|---|---|
resp | *RespLeaveRoom | empty response | true |
err | error | error message | true |
Invite user
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomID | string | room id | true |
req.UserID | string | user id to invite | true |
Returns:
Name | Type | Description | Required |
---|---|---|---|
resp | *ReqInviteUser | empty response | true |
err | error | error message | true |
Kick user
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomID | string | room id | true |
req.UserID | string | user id to kick | true |
req.Reason | string | kick reason | true |
Returns:
Name | Type | Description | Required |
---|---|---|---|
resp | *RespKickUser | empty response | true |
err | error | error message | true |
Send state event
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomID | string | room id | true |
eventType | string | the type of event to send. | true |
stateKey | string | the state_key for the state to send. | true |
contentJSON | string | event content | true |
Returns:
Name | Type | Description | Required |
---|---|---|---|
resp.EventID | string | id for the new event | true |
err | error | error message | true |
Last updated