wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Review comments

Browse source
This commit is contained in:
Daniel Wagner-Hall 2015-10-08 10:08:38 -05:00
parent 21a40b317d
commit dc3c02aff5
3 changed files with 35 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

31
api/client-server/v1/membership.yaml
View file

@ -80,11 +80,6 @@ paths:
They do not start participating in the room until they actually join the
room.
This serves two purposes; firstly, to notify the user that the room
exists (and that their presence is requested). Secondly, some rooms can
only be joined if a user is invited to join it; sending the invite gives
that user permission to join the room.
Only users currently in a particular room can invite other users to
join that room.
@ -142,20 +137,21 @@ paths:
description: |-
*Note that there are two forms of this API, which are documented separately.
This version of the API does not require that the inviter know the Matrix
identifier of the invitee, and instead relies on third party identifiers.*
identifier of the invitee, and instead relies on third party identifiers.
The homeserver uses an identity server to perform the mapping from
third party identifier to a Matrix identifier.*
This API invites a user to participate in a particular room.
They do not start participating in the room until they actually join the
room.
This serves two purposes; firstly, to notify the user that the room
exists (and that their presence is requested). Secondly, some rooms can
only be joined if a user is invited to join it; sending the invite gives
that user permission to join the room.
Only users currently in a particular room can invite other users to
join that room.
If the identity server did know the Matrix user identifier for the
third party identifier, the home server will append a ``m.room.member``
event to the room.
If the identity server does not know a Matrix user identifier for the
passed third party identifier, the homeserver will issue an invitation
which can be accepted upon providing proof of ownership of the third
@ -164,9 +160,9 @@ paths:
add an ``m.room.third_party_invite`` event into the graph for the room,
containing that token.
When a user binds the invited third party identifier to a Matrix user ID,
the identity server will give the user a list of pending invitations,
each containing:
When the invitee binds the invited third party identifier to a Matrix
user ID, the identity server will give the user a list of pending
invitations, each containing:
- The room ID to which they were invited
@ -176,10 +172,6 @@ paths:
- The matrix user ID who invited them to the room
If the identity server did know the Matrix user identifier for the
third party identifier, the home server will append a ``m.room.member``
event to the room.
If a token is requested from the identity server, the home server will
append a ``m.room.third_party_invite`` event to the room.
security:
@ -209,7 +201,8 @@ paths:
description: The hostname+port of the identity server which should be used for third party identifier lookups.
medium:
type: string
description: The kind of address being passed in the address field.
# TODO: Link to identity service spec when it eixsts
description: The kind of address being passed in the address field, for example ``email``.
address:
type: string
description: The invitee's third party identifier.