mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-25 08:33:45 +01:00
00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
72 lines
2.6 KiB
YAML
72 lines
2.6 KiB
YAML
# Copyright 2018 New Vector Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
type: object
|
|
title: m.presence
|
|
description: |-
|
|
An EDU representing presence updates for users of the sending homeserver.
|
|
allOf:
|
|
- $ref: ../edu.yaml
|
|
- type: object
|
|
properties:
|
|
edu_type:
|
|
type: enum
|
|
enum: ['m.presence']
|
|
description: The string ``m.presence``
|
|
example: "m.presence"
|
|
content:
|
|
type: object
|
|
description: The presence updates and requests.
|
|
title: Presence Update
|
|
properties:
|
|
push:
|
|
type: array
|
|
description: |-
|
|
A list of presence updates that the receiving server is likely
|
|
to be interested in.
|
|
items:
|
|
type: object
|
|
title: User Presence Update
|
|
properties:
|
|
user_id:
|
|
type: string
|
|
description: The user ID this presence EDU is for.
|
|
example: "@john:matrix.org"
|
|
presence:
|
|
type: enum
|
|
enum: ['offline', 'unavailable', 'online']
|
|
description: The presence of the user.
|
|
example: "online"
|
|
status_msg:
|
|
type: string
|
|
description: An optional description to accompany the presence.
|
|
example: "Making cupcakes"
|
|
last_active_ago:
|
|
type: integer
|
|
format: int64
|
|
description: |-
|
|
The number of milliseconds that have elapsed since the user
|
|
last did something.
|
|
example: 5000
|
|
currently_active:
|
|
type: boolean
|
|
description: |-
|
|
True if the user is likely to be interacting with their
|
|
client. This may be indicated by the user having a
|
|
``last_active_ago`` within the last few minutes. Defaults
|
|
to false.
|
|
example: true
|
|
required: ['user_id', 'presence', 'last_active_ago']
|
|
required: ['push']
|