archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

RST Formatting for github

Browse Source
pull/977/head
Kegsay 11 years ago
parent a1aaf78186
commit 8ca0c65fd3
1 changed files with 289 additions and 266 deletions
Show Stats Download Patch File Download Diff File

555
drafts/cs-v2-http-api.rst
Unescape Escape View File

@ -24,78 +24,84 @@ TODO: excluding filters (e.g. filter out "org.matrix.neb.*")
XXX: how do we transition between non-coalesced pagination and coalesced pagination for related_to/updates XXX: how do we transition between non-coalesced pagination and coalesced pagination for related_to/updates
POST /user/{userId}/filter ::
{
// selectors: (bluntly selecting on the unencrypted fields) POST /user/{userId}/filter
types: [ "m.*", "net.arasphere.*" ], // default: all
rooms: [ "!83wy7whi:matrix.org" ], // default: all (may be aliases or IDs. wildcards supported) .. code:: javascript
sender_ids: [ "@matthew:matrix.org" ], // default: all (e.g. for narrowing down presence, and stalker mode. wildcards supported)
// XXX: do we want this per-query; is it valid to reuse it?
// we probably don't need this as querying per-event-ID will be a parameter from a seperate API,
// with its own seperate filter token & pagination semantics.
event_ids: [ "$192318719:matrix.org" ], // default: all - useful for selecting relates_to data for a given event
// parameters
// 'format' gives the desired shape of the response
// federation = include the federation layer as well as the raw content of events.
// events = the plain events
format: "federation",
// select specific specific fields of the event to be returned.
// N.B. you cannot guaranteeing filter content fields as they may be encrypted.
// e.g. selecting just event_id could be useful for doing server-side
// sorting/pagination/threading
select: [ "event_id", "origin_server_ts", "thread_id", "content", "content.body" ],
// include bundled child-event updates (default false)
bundle_updates: true,
// include bundled related events
bundle_relates_to: [
{
relationship: "in_reply_to",
// As this is an optimisation to avoid having to explicitly select/paginate the
// related messages per-message, we have to include a limit here as if we were
// actually executing the query per-message for the initial result set.
// Limit gives the number of related events to bundle; the bundled events return chunk tokens
// to let you seperately paginate on them.
limit: 10, // maximum number of related events to bundle in the results of this filtered result set.
ancestors: true, // include all ancestors (default: true)
descendents: true, // include all descendents (default: true)
<recursively include a filter definition here for the subset of events>
// need to support a sort criteria which reflects the linearised ordering of the relation graph
},
],
// server-side sorting, so we can paginate serverside on a thin client. {
// N.B. we can only order by unencrypted fields. // selectors: (bluntly selecting on the unencrypted fields)
// N.B. clients will need to handle out-of-order messages intelligently types: [ "m.*", "net.arasphere.*" ], // default: all
// N.B. subset of things you're allowed to sort by may be arbitrarily rooms: [ "!83wy7whi:matrix.org" ], // default: all (may be aliases or IDs. wildcards supported)
restricted by the server impl (XXX: capabilities?) sender_ids: [ "@matthew:matrix.org" ], // default: all (e.g. for narrowing down presence, and stalker mode. wildcards supported)
// Servers must support the "timeline" ordering - which is linearised logical chronological ordering.
// XXX: should this be done per-request rather than per-filter? Given streaming APIs (like eventStream) // XXX: do we want this per-query; is it valid to reuse it?
// will be limited to sorting via timeline due to causality... // we probably don't need this as querying per-event-ID will be a parameter from a seperate API,
sort: [ // with its own seperate filter token & pagination semantics.
// sort by sender, and then by the timeline event_ids: [ "$192318719:matrix.org" ], // default: all - useful for selecting relates_to data for a given event
{
type: "sender_id", // parameters
dir: "asc", // default asc
}, // 'format' gives the desired shape of the response
{ // federation = include the federation layer as well as the raw content of events.
type: "timeline", // events = the plain events
dir: "asc", format: "federation",
},
], // select specific specific fields of the event to be returned.
} // N.B. you cannot guaranteeing filter content fields as they may be encrypted.
// e.g. selecting just event_id could be useful for doing server-side
// sorting/pagination/threading
select: [ "event_id", "origin_server_ts", "thread_id", "content", "content.body" ],
// include bundled child-event updates (default false)
bundle_updates: true,
// include bundled related events
bundle_relates_to: [
{
relationship: "in_reply_to",
// As this is an optimisation to avoid having to explicitly select/paginate the
// related messages per-message, we have to include a limit here as if we were
// actually executing the query per-message for the initial result set.
// Limit gives the number of related events to bundle; the bundled events return chunk tokens
// to let you seperately paginate on them.
limit: 10, // maximum number of related events to bundle in the results of this filtered result set.
ancestors: true, // include all ancestors (default: true)
descendents: true, // include all descendents (default: true)
<recursively include a filter definition here for the subset of events>
// need to support a sort criteria which reflects the linearised ordering of the relation graph
},
],
// server-side sorting, so we can paginate serverside on a thin client.
// N.B. we can only order by unencrypted fields.
// N.B. clients will need to handle out-of-order messages intelligently
// N.B. subset of things you're allowed to sort by may be arbitrarily
// restricted by the server impl (XXX: capabilities?)
// Servers must support the "timeline" ordering - which is linearised logical chronological ordering.
// XXX: should this be done per-request rather than per-filter? Given streaming APIs (like eventStream)
// will be limited to sorting via timeline due to causality...
sort: [
// sort by sender, and then by the timeline
{
type: "sender_id",
dir: "asc", // default asc
},
{
type: "timeline",
dir: "asc",
},
],
}
Returns: Returns::
200 OK
{ 200 OK
"filter_id": "583e98c2d983", {
} "filter_id": "583e98c2d983"
}
Global initial sync API Global initial sync API
@ -104,6 +110,7 @@ Global initial sync API
GET /initialSync GET /initialSync
GET parameters:: GET parameters::
limit: maximum number of events per room to return limit: maximum number of events per room to return
sort: fieldname, direction (e.g. "sender_id,asc"). // default: "timeline,asc". may appear multiple times. sort: fieldname, direction (e.g. "sender_id,asc"). // default: "timeline,asc". may appear multiple times.
since: <chunk token> to request an incremental update (*not* pagination) since the specified chunk token since: <chunk token> to request an incremental update (*not* pagination) since the specified chunk token
@ -122,30 +129,60 @@ GET parameters::
filter_select: event fields to return: default, all. may appear multiple times filter_select: event fields to return: default, all. may appear multiple times
filter_bundle_updates: true/false: default, false. bundle updates in events. filter_bundle_updates: true/false: default, false. bundle updates in events.
// FIXME: kegan: how much does the v1 response actually change here? // FIXME: kegan: how much does the v1 response actually change here?
Returns: Returns:
200 OK
// where compact is false: .. code:: javascript
{
"end": "s72595_4483_1934", // the chunk token we pass to from= 200 OK
// where compact is false:
// global presence info (if presence=true) {
"presence": [{ "end": "s72595_4483_1934", // the chunk token we pass to from=
"content": {
"avatar_url": "http://matrix.tp.mu:8008/_matrix/content/QG1hdHRoZXc6dHAubXUOeJQMWFMvUdqdeLovZKsyaOT.aW1hZ2UvanBlZw==.jpeg", // global presence info (if presence=true)
"displayname": "Matthew Hodgson", "presence": [{
"last_active_ago": 368200528, "content": {
"presence": "online", "avatar_url": "http://matrix.tp.mu:8008/_matrix/content/QG1hdHRoZXc6dHAubXUOeJQMWFMvUdqdeLovZKsyaOT.aW1hZ2UvanBlZw==.jpeg",
"user_id": "@matthew:tp.mu" "displayname": "Matthew Hodgson",
}, "last_active_ago": 368200528,
"type": "m.presence" "presence": "online",
}], "user_id": "@matthew:tp.mu"
},
"rooms": [{ "type": "m.presence"
"membership": "join", }],
"eventStream": { // rename messages to eventstream as this is a list of all events, not just messages (non-state events)
"chunk": [{ "rooms": [{
"membership": "join",
"eventStream": { // rename messages to eventstream as this is a list of all events, not just messages (non-state events)
"chunk": [{
"content": {
"avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg",
"displayname": "Matthew",
"membership": "join"
},
"event_id": "$1417731086506PgoVf:matrix.org",
"membership": "join",
"origin_server_ts": 1417731086795,
"prev_content": {
"avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg",
"displayname": "Ara4n",
"membership": "join"
}
"prev_state": [["$1416420706925RVAWP:matrix.org", {
"sha256": "zVzi02R5aeO2HQDnybu1XuuyR6yBG8utLE/i1Sv8eyA"
}
]],
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"state_key": "@matthew:matrix.org",
"type": "m.room.member",
"user_id": "@matthew:matrix.org"
}],
"end": "s72595_4483_1934",
"start": "t67-41151_4483_1934"
},
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"state": [{
"content": { "content": {
"avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg", "avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg",
"displayname": "Matthew", "displayname": "Matthew",
@ -154,94 +191,68 @@ Returns:
"event_id": "$1417731086506PgoVf:matrix.org", "event_id": "$1417731086506PgoVf:matrix.org",
"membership": "join", "membership": "join",
"origin_server_ts": 1417731086795, "origin_server_ts": 1417731086795,
"prev_content": {
"avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg",
"displayname": "Ara4n",
"membership": "join"
}
"prev_state": [["$1416420706925RVAWP:matrix.org", {
"sha256": "zVzi02R5aeO2HQDnybu1XuuyR6yBG8utLE/i1Sv8eyA"
}
]],
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org", "room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"state_key": "@matthew:matrix.org", "state_key": "@matthew:matrix.org",
"type": "m.room.member", "type": "m.room.member",
"user_id": "@matthew:matrix.org" "user_id": "@matthew:matrix.org"
}], }],
"end": "s72595_4483_1934", "visibility": "public"
"start": "t67-41151_4483_1934" }]
}, }
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"state": [{
// where compact is true:
{
"end": "s72595_4483_1934",
// global presence info
"presence": [{
"content": { "content": {
"avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg", "avatar_url": "http://matrix.tp.mu:8008/_matrix/content/QG1hdHRoZXc6dHAubXUOeJQMWFMvUdqdeLovZKsyaOT.aW1hZ2UvanBlZw==.jpeg",
"displayname": "Matthew", "displayname": "Matthew Hodgson",
"membership": "join" "last_active_ago": 368200528,
"presence": "online",
"user_id": "@matthew:tp.mu"
}, },
"event_id": "$1417731086506PgoVf:matrix.org", "type": "m.presence"
"membership": "join",
"origin_server_ts": 1417731086795,
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"state_key": "@matthew:matrix.org",
"type": "m.room.member",
"user_id": "@matthew:matrix.org"
}], }],
"visibility": "public" "rooms": [{
}] "events": {
} "$1417731086506PgoVf:matrix.org": {
"content": {
"avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg",
// where compact is true: "displayname": "Matthew",
{ "membership": "join"
"end": "s72595_4483_1934", },
// global presence info "membership": "join",
"presence": [{ "origin_server_ts": 1417731086795,
"content": { "prev_state": [["$1416420706925RVAWP:matrix.org", {
"avatar_url": "http://matrix.tp.mu:8008/_matrix/content/QG1hdHRoZXc6dHAubXUOeJQMWFMvUdqdeLovZKsyaOT.aW1hZ2UvanBlZw==.jpeg", "sha256": "zVzi02R5aeO2HQDnybu1XuuyR6yBG8utLE/i1Sv8eyA"
"displayname": "Matthew Hodgson", }
"last_active_ago": 368200528, ]],
"presence": "online", "room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"user_id": "@matthew:tp.mu" "state_key": "@matthew:matrix.org",
}, "type": "m.room.member",
"type": "m.presence" "user_id": "@matthew:matrix.org"
}],
"rooms": [{
"events": {
"$1417731086506PgoVf:matrix.org": {
"content": {
"avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg",
"displayname": "Matthew",
"membership": "join"
},
"membership": "join",
"origin_server_ts": 1417731086795,
"prev_state": [["$1416420706925RVAWP:matrix.org", {
"sha256": "zVzi02R5aeO2HQDnybu1XuuyR6yBG8utLE/i1Sv8eyA"
} }
]], },
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org", "membership": "join",
"state_key": "@matthew:matrix.org", "eventStream": { // rename messages to eventstream as this is a list of all events, not just messages (non-state events)
"type": "m.room.member", "chunk": [ "$1417731086506PgoVf:matrix.org" ],
"user_id": "@matthew:matrix.org" "end": "s72595_4483_1934",
} "start": "t67-41151_4483_1934" // XXX: do we need start?
}, },
"membership": "join", "room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"eventStream": { // rename messages to eventstream as this is a list of all events, not just messages (non-state events) "state": [ "$1417731086506PgoVf:matrix.org" ],
"chunk": [ "$1417731086506PgoVf:matrix.org" ], "visibility": "public"
"end": "s72595_4483_1934", }]
"start": "t67-41151_4483_1934" // XXX: do we need start? }
},
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"state": [ "$1417731086506PgoVf:matrix.org" ],
"visibility": "public"
}]
}
Event Stream API Event Stream API
---------------- ----------------
GET /eventStream GET /eventStream
GET parameters:: GET parameters::
from: chunk token to continue streaming from (e.g. "end" given by initialsync) from: chunk token to continue streaming from (e.g. "end" given by initialsync)
filter*: as per initialSync (XXX: do we inherit this from the chunk token?) filter*: as per initialSync (XXX: do we inherit this from the chunk token?)
// N.B. there is no limit or sort param here, as we get events in timeline order as fast as they come. // N.B. there is no limit or sort param here, as we get events in timeline order as fast as they come.
@ -249,38 +260,40 @@ GET parameters::
timeout: maximum time to poll before returning the request timeout: maximum time to poll before returning the request
presence: "offline" // optional parameter to tell the server not to interpret this as coming online presence: "offline" // optional parameter to tell the server not to interpret this as coming online
XXX: this needs to be updated from v1. Presumably s/user_id/sender_id/? XXX: this needs to be updated from v1. Presumably s/user_id/sender_id/?
Returns: Returns:
200 OK 200 OK
// events precisely as per a room's eventStream key as returned by initialSync .. code:: javascript
// includes non-graph events like presence
{ // events precisely as per a room's eventStream key as returned by initialSync
"chunk": [{ // includes non-graph events like presence
"content": { {
"avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg", "chunk": [{
"displayname": "Matthew", "content": {
"last_active_ago": 1241, "avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg",
"presence": "online", "displayname": "Matthew",
"last_active_ago": 1241,
"presence": "online",
"user_id": "@matthew:matrix.org"
},
"type": "m.presence"
}, {
"age": 2595,
"content": {
"body": "test",
"msgtype": "m.text"
},
"event_id": "$14211894201675TMbmz:matrix.org",
"origin_server_ts": 1421189420147,
"room_id": "!cURbafjkfsMDVwdRDQ:matrix.org",
"type": "m.room.message",
"user_id": "@matthew:matrix.org" "user_id": "@matthew:matrix.org"
}, }],
"type": "m.presence" "end": "s75460_2478_981",
}, { "start": "s75459_2477_981" // XXX: do we need start here?
"age": 2595, }
"content": {
"body": "test",
"msgtype": "m.text"
},
"event_id": "$14211894201675TMbmz:matrix.org",
"origin_server_ts": 1421189420147,
"room_id": "!cURbafjkfsMDVwdRDQ:matrix.org",
"type": "m.room.message",
"user_id": "@matthew:matrix.org"
}],
"end": "s75460_2478_981",
"start": "s75459_2477_981" // XXX: do we need start here?
}
Room Creation API Room Creation API
----------------- -----------------
@ -296,84 +309,90 @@ Scrollback API
GET /rooms/<room_id>/events GET /rooms/<room_id>/events
GET parameters:: GET parameters::
from: the chunk token to paginate from from: the chunk token to paginate from
Otherwise same as initialSync, except "compact", "since" and "presence" are not implemented Otherwise same as initialSync, except "compact", "since" and "presence" are not implemented
Returns: Returns:
200 OK 200 OK
// events precisely as per a room's eventStream key as returned by initialSync .. code:: javascript
{
"chunk": [{ // events precisely as per a room's eventStream key as returned by initialSync
"age": 28153452, // XXX: age and origin_server_ts are redundant here surely {
"content": { "chunk": [{
"body": "but obviously the XSF believes XMPP is the One True Way", "age": 28153452, // XXX: age and origin_server_ts are redundant here surely
"msgtype": "m.text" "content": {
}, "body": "but obviously the XSF believes XMPP is the One True Way",
"event_id": "$1421165049511TJpDp:matrix.org", "msgtype": "m.text"
"origin_server_ts": 1421165049435, },
"room_id": "!cURbafjkfsMDVwdRDQ:matrix.org", "event_id": "$1421165049511TJpDp:matrix.org",
"type": "m.room.message", "origin_server_ts": 1421165049435,
"user_id": "@irc_Arathorn:matrix.org" "room_id": "!cURbafjkfsMDVwdRDQ:matrix.org",
}, { "type": "m.room.message",
"age": 28167245, "user_id": "@irc_Arathorn:matrix.org"
"content": { }, {
"body": "which is all fair enough", "age": 28167245,
"msgtype": "m.text" "content": {
}, "body": "which is all fair enough",
"event_id": "$1421165035510CBwsU:matrix.org", "msgtype": "m.text"
"origin_server_ts": 1421165035643, },
"room_id": "!cURbafjkfsMDVwdRDQ:matrix.org", "event_id": "$1421165035510CBwsU:matrix.org",
"type": "m.room.message", "origin_server_ts": 1421165035643,
"user_id": "@irc_Arathorn:matrix.org" "room_id": "!cURbafjkfsMDVwdRDQ:matrix.org",
}], "type": "m.room.message",
"end": "t9571-74545_2470_979", "user_id": "@irc_Arathorn:matrix.org"
"start": "t9601-75400_2470_979" // XXX: don't we just need end here as we can only paginate one way? }],
} "end": "t9571-74545_2470_979",
"start": "t9601-75400_2470_979" // XXX: don't we just need end here as we can only paginate one way?
}
Contextual windowing API Contextual windowing API
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
GET /events/<event_id> GET /events/<event_id>
GET parameters: GET parameters::
context: "before", "after" or "around" context: "before", "after" or "around"
Otherwise same as initialSync, except "since" and "presence" are not implemented Otherwise same as initialSync, except "since" and "presence" are not implemented
Returns: Returns:
200 OK 200 OK
// the room in question, formatted exactly as a room entry returned by /initialSync .. code:: javascript
// with the event in question present in the list as determined by the context param
{ // the room in question, formatted exactly as a room entry returned by /initialSync
"events": { // with the event in question present in the list as determined by the context param
"$1417731086506PgoVf:matrix.org": { {
"content": { "events": {
"avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg", "$1417731086506PgoVf:matrix.org": {
"displayname": "Matthew", "content": {
"membership": "join" "avatar_url": "https://matrix.org/_matrix/content/QG1hdHRoZXc6bWF0cml4Lm9yZwxaesQWnqdynuXIYaRisFnZdG.aW1hZ2UvanBlZw==.jpeg",
}, "displayname": "Matthew",
"membership": "join", "membership": "join"
"origin_server_ts": 1417731086795, },
"prev_state": [["$1416420706925RVAWP:matrix.org", { "membership": "join",
"sha256": "zVzi02R5aeO2HQDnybu1XuuyR6yBG8utLE/i1Sv8eyA" "origin_server_ts": 1417731086795,
"prev_state": [["$1416420706925RVAWP:matrix.org", {
"sha256": "zVzi02R5aeO2HQDnybu1XuuyR6yBG8utLE/i1Sv8eyA"
}
]],
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"state_key": "@matthew:matrix.org",
"type": "m.room.member",
"user_id": "@matthew:matrix.org"
} }
]], },
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org", "membership": "join",
"state_key": "@matthew:matrix.org", "eventStream": {
"type": "m.room.member", "chunk": [ "$1417731086506PgoVf:matrix.org" ],
"user_id": "@matthew:matrix.org" "end": "s72595_4483_1934",
} "start": "t67-41151_4483_1934"
}, },
"membership": "join", "room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"eventStream": { "state": [ "$1417731086506PgoVf:matrix.org" ],
"chunk": [ "$1417731086506PgoVf:matrix.org" ], "visibility": "public"
"end": "s72595_4483_1934", }
"start": "t67-41151_4483_1934"
},
"room_id": "!KrLWMLDnZAyTapqLWW:matrix.org",
"state": [ "$1417731086506PgoVf:matrix.org" ],
"visibility": "public"
}
Room Alias API Room Alias API
@ -389,10 +408,12 @@ Provides arbitrary per-user global state JSON storage with namespaced keys,
some of which have specific predefined serverside semantics. Keys must be named some of which have specific predefined serverside semantics. Keys must be named
(we don't support POSTing to anonymous key names) (we don't support POSTing to anonymous key names)
PUT /user/{userId}/data/m.displayname ::
PUT /user/{userId}/data/m.avatar_url
PUT /user/{userId}/data/m.contact_vcard PUT /user/{userId}/data/m.displayname
PUT /user/{userId}/data/net.arasphere.client.preferences PUT /user/{userId}/data/m.avatar_url
PUT /user/{userId}/data/m.contact_vcard
PUT /user/{userId}/data/net.arasphere.client.preferences
Account Management API Account Management API
---------------------- ----------------------
@ -403,17 +424,19 @@ Actions API
Presence API Presence API
------------ ------------
PUT /user/{userId}/presence/m.status // set DND/asleep/on holiday etc - ::
// XXX: do we need to distinguish between internationalisable presets like DND
// and free-form textual status messages?
// XXX: should this be in /user/{userId}/data/m.status instead?
// what's actually the difference? surely status is no different to avatar
// updates in terms of needing to be pushed around
PUT /device/{deviceId}/presence/m.presence // explicitly set online/idle/offline
// or /presence/device/{deviceId}
// XXX: need to remember how to handle activity notifications PUT /user/{userId}/presence/m.status // set DND/asleep/on holiday etc -
// XXX: do we need to distinguish between internationalisable presets like DND
// and free-form textual status messages?
// XXX: should this be in /user/{userId}/data/m.status instead?
// what's actually the difference? surely status is no different to avatar
// updates in terms of needing to be pushed around
PUT /device/{deviceId}/presence/m.presence // explicitly set online/idle/offline
// or /presence/device/{deviceId}
// XXX: need to remember how to handle activity notifications
Typing API Typing API
---------- ----------

Write Preview
Loading…
Cancel
Save