summary:Create a new mapping from room alias to room ID.
summary:Create a new mapping from room alias to room ID.
operationId:setRoomAlias
security:
security:
- accessToken:[]
- accessToken:[]
parameters:
parameters:
@ -78,6 +79,7 @@ paths:
domain part of the alias does not correspond to the server's own
domain part of the alias does not correspond to the server's own
domain.
domain.
operationId:getRoomIdByAlias
parameters:
parameters:
- in:path
- in:path
type:string
type:string
@ -124,6 +126,7 @@ paths:
Remove a mapping of room alias to room ID.
Remove a mapping of room alias to room ID.
Servers may choose to implement additional access control checks here, for instance that room aliases can only be deleted by their creator or a server administrator.
Servers may choose to implement additional access control checks here, for instance that room aliases can only be deleted by their creator or a server administrator.
joined to the room then the state is taken from the current
joined to the room then the state is taken from the current
state of the room. If the user has left the room then the state is
state of the room. If the user has left the room then the state is
taken from the state of the room when they left.
taken from the state of the room when they left.
operationId:getRoomStateWithKey
security:
security:
- accessToken:[]
- accessToken:[]
parameters:
parameters:
@ -82,6 +83,7 @@ paths:
taken from the state of the room when they left.
taken from the state of the room when they left.
This looks up the state event with the empty state key.
This looks up the state event with the empty state key.
operationId:getRoomStateByType
security:
security:
- accessToken:[]
- accessToken:[]
parameters:
parameters:
@ -118,6 +120,7 @@ paths:
summary:Get all state events in the current state of a room.
summary:Get all state events in the current state of a room.
description:|-
description:|-
Get the state events for the current state of a room.
Get the state events for the current state of a room.
operationId:getRoomState
security:
security:
- accessToken:[]
- accessToken:[]
parameters:
parameters:
@ -234,6 +237,7 @@ paths:
summary:Get the m.room.member events for the room.
summary:Get the m.room.member events for the room.
description:
description:
Get the list of members for this room.
Get the list of members for this room.
operationId:getMembersByRoom
parameters:
parameters:
- in:path
- in:path
type:string
type:string
@ -303,6 +307,7 @@ paths:
description:
description:
This API returns a map of MXIDs to member info objects for members of the room. The current user must be in the room for it to work, unless it is an Application Service in which case any of the AS's users must be in the room.
This API returns a map of MXIDs to member info objects for members of the room. The current user must be in the room for it to work, unless it is an Application Service in which case any of the AS's users must be in the room.
This API is primarily for Application Services and should be faster to respond than ``/members`` as it can be implemented more efficiently on the server.
This API is primarily for Application Services and should be faster to respond than ``/members`` as it can be implemented more efficiently on the server.