mirror of
https://github.com/jech/galene.git
synced 2024-11-09 18:25:58 +01:00
Update README.PROTOCOL.
This commit is contained in:
parent
4d2c87bdc4
commit
ea7142ca9a
1 changed files with 7 additions and 4 deletions
|
@ -64,6 +64,8 @@ message types:
|
||||||
|
|
||||||
- `type`, the type of the message;
|
- `type`, the type of the message;
|
||||||
- `kind`, the subtype of the message;
|
- `kind`, the subtype of the message;
|
||||||
|
- `error`, indicates that the message is an error indication, and
|
||||||
|
specifies the kind of error that occurred;
|
||||||
- `id`, the id of the object being manipulated;
|
- `id`, the id of the object being manipulated;
|
||||||
- `source`, the client-id of the originating client;
|
- `source`, the client-id of the originating client;
|
||||||
- `username`, the username of the originating client;
|
- `username`, the username of the originating client;
|
||||||
|
@ -96,8 +98,8 @@ start pipelining messages to the server.
|
||||||
|
|
||||||
The version field contains an array of supported protocol versions, in
|
The version field contains an array of supported protocol versions, in
|
||||||
decreasing preference order; the client may announce multiple versions,
|
decreasing preference order; the client may announce multiple versions,
|
||||||
but the server will always reply with a singleton. If the field `id` is
|
but the server will always reply with a single version. If the field `id`
|
||||||
absent, then the peer doesn't originate streams.
|
is absent, then the peer doesn't originate streams.
|
||||||
|
|
||||||
A peer may, at any time, send a `ping` message.
|
A peer may, at any time, send a `ping` message.
|
||||||
|
|
||||||
|
@ -142,6 +144,7 @@ its permissions or in the recommended RTC configuration.
|
||||||
{
|
{
|
||||||
type: 'joined',
|
type: 'joined',
|
||||||
kind: 'join' or 'fail' or 'change' or 'leave',
|
kind: 'join' or 'fail' or 'change' or 'leave',
|
||||||
|
error: may be set if kind is 'fail',
|
||||||
group: group,
|
group: group,
|
||||||
username: username,
|
username: username,
|
||||||
permissions: permissions,
|
permissions: permissions,
|
||||||
|
@ -154,8 +157,8 @@ its permissions or in the recommended RTC configuration.
|
||||||
The `username` field is the username that the server assigned to this
|
The `username` field is the username that the server assigned to this
|
||||||
user. The `permissions` field is an array of strings that may contain the
|
user. The `permissions` field is an array of strings that may contain the
|
||||||
values `present`, `op` and `record`. The `status` field is a dictionary
|
values `present`, `op` and `record`. The `status` field is a dictionary
|
||||||
that contains status information about the group, in the same format as at
|
that contains status information about the group, and updates the data
|
||||||
the `.status.json` URL above.
|
obtained from the `.status.json` URL described above.
|
||||||
|
|
||||||
## Maintaining group membership
|
## Maintaining group membership
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue