async-matrix 3.0.1 → 4.0.0

data/data/matrix-spec/event-schemas/schema/m.call.answer.yaml

@@ -1,44 +0,0 @@
-{
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "type": "object",
-    "description": "This event is sent by the callee when they wish to answer the call.",
-    "x-weight": 40,
-    "allOf": [{
-        "$ref": "core-event-schema/room_event.yaml"
-    }],
-    "properties": {
-        "content": {
-            "type": "object",
-            "allOf": [{
-                "$ref": "core-event-schema/call_event.yaml"
-            }],
-            "properties": {
-                "answer": {
-                    "type": "object",
-                    "title": "Answer",
-                    "description": "The session description object",
-                    "properties": {
-                        "type": {
-                            "type": "string",
-                            "enum": ["answer"],
-                            "description": "The type of session description."
-                        },
-                        "sdp": {
-                            "type": "string",
-                            "description": "The SDP text of the session description."
-                        }
-                    },
-                    "required": ["type", "sdp"]
-                },
-                "sdp_stream_metadata": {
-                    "$ref": "components/sdp_stream_metadata.yaml"
-                }
-            },
-            "required": ["answer"]
-        },
-        "type": {
-            "type": "string",
-            "enum": ["m.call.answer"]
-        }
-    }
-}

data/data/matrix-spec/event-schemas/schema/m.call.candidates.yaml

@@ -1,52 +0,0 @@
-$schema: https://json-schema.org/draft/2020-12/schema
-
-type: object
-description: |-
-  This event is sent by callers after sending an invite and by the callee after
-  answering. Its purpose is to give the other party additional ICE candidates to
-  try using to communicate.
-x-weight: 20
-allOf:
-  - $ref: core-event-schema/room_event.yaml
-properties:
-  content:
-    type: object
-    allOf:
-      - $ref: core-event-schema/call_event.yaml
-    properties:
-      candidates:
-        type: array
-        description: Array of objects describing the candidates.
-        items:
-          type: object
-          title: Candidate
-          properties:
-            sdpMid:
-              type: string
-              description: |-
-                The SDP media type this candidate is intended for.
-
-                At least one of `sdpMid` or `sdpMLineIndex` is required, unless
-                this an end-of-candidates candidate.
-            sdpMLineIndex:
-              type: number
-              description: |-
-                The index of the SDP 'm' line this candidate is intended for.
-
-                At least one of `sdpMid` or `sdpMLineIndex` is required, unless
-                this an end-of-candidates candidate.
-            candidate:
-              type: string
-              description: |-
-                The SDP 'a' line of the candidate.
-
-                If this is an [end-of-candidates](/client-server-api/#end-of-candidates)
-                candidate, this is the empty string.
-          required:
-            - candidate
-    required:
-      - candidates
-  type:
-    type: string
-    enum:
-      - m.call.candidates

data/data/matrix-spec/event-schemas/schema/m.call.hangup.yaml

@@ -1,57 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-type: object
-description: |
-  Sent by either party to signal their termination of the call. This can
-  be sent either once the call has has been established or before to abort the call.
-
-  The meanings of the `reason` field are as follows:
-   * `ice_failed`: ICE negotiation has failed and a media connection could not be established.
-   * `ice_timeout`: The connection failed after some media was exchanged (as opposed to `ice_failed`
-      which means no media connection could be established). Note that, in the case of an ICE
-      renegotiation, a client should be sure to send `ice_timeout` rather than `ice_failed` if media
-      had previously been received successfully, even if the ICE renegotiation itself failed.
-   * `invite_timeout`: The other party did not answer in time.
-   * `user_hangup`: Clients must now send this code when the user chooses to end the call, although
-     for backwards compatibility with version 0, a clients should treat an absence of the `reason`
-     field as `user_hangup`.
-   * `user_media_failed`: The client was unable to start capturing media in such a way that it is unable
-     to continue the call.
-   * `user_busy`: The user is busy. Note that this exists primarily for bridging to other networks such
-      as the PSTN. A Matrix client that receives a call whilst already in a call would not generally reject
-      the new call unless the user had specifically chosen to do so.
-   * `unknown_error`: Some other failure occurred that meant the client was unable to continue the call
-      rather than the user choosing to end it.
-x-weight: 80
-allOf:
-- "$ref": core-event-schema/room_event.yaml
-properties:
-  content:
-    type: object
-    allOf:
-    - "$ref": core-event-schema/call_event.yaml
-    properties:
-      reason:
-        type: string
-        description: Reason for the hangup. Note that this was optional in
-          previous previous versions of the spec, so a missing value should be
-          treated as `user_hangup`.
-        x-changedInMatrixVersion:
-          "1.7": |-
-            Additional values were added.
-        enum:
-        - ice_timeout
-        - ice_failed
-        - invite_timeout
-        - user_hangup
-        - user_media_failed
-        - user_busy
-        - unknown_error
-    required:
-    - reason
-  type:
-    type: string
-    enum:
-    - m.call.hangup
-

data/data/matrix-spec/event-schemas/schema/m.call.invite.yaml

@@ -1,53 +0,0 @@
-{
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "type": "object",
-    "description": "This event is sent by the caller when they wish to establish a call.",
-    "x-weight": 10,
-    "allOf": [{
-        "$ref": "core-event-schema/room_event.yaml"
-    }],
-    "properties": {
-        "content": {
-            "type": "object",
-            "allOf": [{
-                "$ref": "core-event-schema/call_event.yaml"
-            }],
-            "properties": {
-                "offer": {
-                    "type": "object",
-                    "title": "Offer",
-                    "description": "The session description object",
-                    "properties": {
-                        "type": {
-                            "type": "string",
-                            "enum": ["offer"],
-                            "description": "The type of session description."
-                        },
-                        "sdp": {
-                            "type": "string",
-                            "description": "The SDP text of the session description."
-                        }
-                    },
-                    "required": ["type", "sdp"]
-                },
-                "lifetime": {
-                    "type": "integer",
-                    "description": "The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI."
-                },
-                "invitee": {
-                    "type": "string",
-                    "description": "The ID of the user being called. If omitted, any user in the room can answer.",
-                    "x-addedInMatrixVersion": "1.7"
-                },
-                "sdp_stream_metadata": {
-                    "$ref": "components/sdp_stream_metadata.yaml"
-                }
-            },
-            "required": ["offer", "lifetime"]
-        },
-        "type": {
-            "type": "string",
-            "enum": ["m.call.invite"]
-        }
-    }
-}

data/data/matrix-spec/event-schemas/schema/m.call.negotiate.yaml

@@ -1,78 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-type: object
-description: |
-  Provides SDP negotiation semantics for media pause, hold/resume, ICE restarts
-  and voice/video call up/downgrading. Clients should implement and honour hold
-  functionality as per [WebRTC's recommendation](https://www.w3.org/TR/webrtc/#hold-functionality).
-
-  If both the invite event and the accepted answer event have `version` equal
-  to `"1"`, either party may send `m.call.negotiate` with a `description` field
-  to offer new SDP to the other party. This event has `call_id` with the ID of
-  the call and `party_id` equal to the client's party ID for that call.  The
-  caller ignores any negotiate events with `party_id` + `user_id` tuple not
-  equal to that of the answer it accepted and the callee ignores any negotiate
-  events with `party_id` + `user_id` tuple not equal to that of the caller.
-  Clients should use the `party_id` field to ignore the remote echo of their
-  own negotiate events.
-
-  This has a `lifetime` field as in `m.call.invite`, after which the sender of
-  the negotiate event should consider the negotiation failed (timed out) and
-  the recipient should ignore it.
-
-  The `description` field is the same as the `offer` field in `m.call.invite`
-  and `answer` field in `m.call.answer` and is an `RTCSessionDescriptionInit`
-  object as per https://www.w3.org/TR/webrtc/#dom-rtcsessiondescriptioninit.
-
-  Once an `m.call.negotiate` event is received, the client must respond with
-  another `m.call.negotiate` event, with the SDP answer (with `"type": "answer"`)
-  in the `description` property.
-
-  In the `m.call.invite` and `m.call.answer` events, the `offer` and `answer`
-  fields respectively are objects of type `RTCSessionDescriptionInit`.  Hence
-  the `type` field, whilst redundant in these events, is included for ease of
-  working with the WebRTC API and is mandatory. Receiving clients should not
-  attempt to validate the `type` field, but simply pass the object into the
-  WebRTC API.
-x-addedInMatrixVersion: "1.7"
-x-weight: 60
-allOf:
-- "$ref": core-event-schema/room_event.yaml
-properties:
-  content:
-    type: object
-    allOf:
-    - "$ref": core-event-schema/call_event.yaml
-    properties:
-      description:
-        type: object
-        title: Description
-        description: The session description object
-        properties:
-          type:
-            type: string
-            enum:
-            - offer
-            - answer
-            description: The type of session description.
-          sdp:
-            type: string
-            description: The SDP text of the session description.
-        required:
-        - type
-        - sdp
-      lifetime:
-        type: integer
-        description: The time in milliseconds that the negotiation is valid for.
-          Once the negotiation age exceeds this value, clients should discard it.
-      sdp_stream_metadata:
-        $ref: components/sdp_stream_metadata.yaml
-    required:
-    - description
-    - lifetime
-  type:
-    type: string
-    enum:
-    - m.call.negotiate
-

data/data/matrix-spec/event-schemas/schema/m.call.reject.yaml

@@ -1,29 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-type: object
-description: |
-  If the `m.call.invite` event has `version` `"1"`, a client wishing to
-  reject the call sends an `m.call.reject` event. This rejects the call on all devices,
-  but if the calling device sees an `answer` before the `reject`, it disregards the
-  reject event and carries on. The reject has a `party_id` just like an answer, and
-  the caller sends a `select_answer` for it just like an answer. If another client
-  had already sent an answer and sees the caller select the reject response instead
-  of its answer, it ends the call. If the `m.call.invite` event has `version` `0`,
-  the callee sends an `m.call.hangup` event. If the calling user chooses to end the
-  call before setup is complete, the client sends `m.call.hangup` as previously.
-
-  Note that, unlike `m.call.hangup`, this event has no `reason` field: the rejection of
-  a call is always implicitly because the user chose not to answer it.
-x-addedInMatrixVersion: "1.7"
-x-weight: 30
-allOf:
-- "$ref": core-event-schema/room_event.yaml
-properties:
-  content:
-    "$ref": core-event-schema/call_event.yaml
-  type:
-    type: string
-    enum:
-    - m.call.reject
-

data/data/matrix-spec/event-schemas/schema/m.call.sdp_stream_metadata_changed.yaml

@@ -1,24 +0,0 @@
-$schema: https://json-schema.org/draft/2020-12/schema
-
-type: object
-x-addedInMatrixVersion: "1.11"
-x-weight: 70
-description: |-
-  This event is sent by callers when they wish to update a stream's metadata
-  but no negotiation is required.
-allOf:
-  - $ref: core-event-schema/room_event.yaml
-properties:
-  content:
-    type: object
-    allOf:
-    - $ref: core-event-schema/call_event.yaml
-    properties:
-      sdp_stream_metadata:
-        $ref: components/sdp_stream_metadata.yaml
-    required:
-    - sdp_stream_metadata
-  type:
-    type: string
-    enum:
-    - m.call.sdp_stream_metadata_changed

data/data/matrix-spec/event-schemas/schema/m.call.select_answer.yaml

@@ -1,29 +0,0 @@
-{
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "type": "object",
-    "description": "This event is sent by the caller's client once it has decided which other client to talk to, by selecting one of multiple possible incoming `m.call.answer` events. Its `selected_party_id` field indicates the answer it's chosen. The `call_id` and `party_id` of the caller is also included. If the callee's client sees a `select_answer` for an answer with party ID other than the one it sent, it ends the call and informs the user the call was answered elsewhere. It does not send any events. Media can start flowing before this event is seen or even sent.  Clients that implement previous versions of this specification will ignore this event and behave as they did before.",
-    "x-addedInMatrixVersion": "1.7",
-    "x-weight": 50,
-    "allOf": [{
-        "$ref": "core-event-schema/room_event.yaml"
-    }],
-    "properties": {
-        "content": {
-            "type": "object",
-            "allOf": [{
-                "$ref": "core-event-schema/call_event.yaml"
-            }],
-            "properties": {
-                "selected_party_id": {
-                    "type": "string",
-                    "description": "The `party_id` field from the answer event that the caller chose."
-                },
-            },
-            "required": ["selected_party_id"]
-        },
-        "type": {
-            "type": "string",
-            "enum": ["m.call.select_answer"]
-        }
-    }
-}

data/data/matrix-spec/event-schemas/schema/m.direct.yaml

@@ -1,29 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-allOf:
-  - $ref: core-event-schema/event.yaml
-description: |-
-  A map of which rooms are considered 'direct' rooms for specific users
-  is kept in  `account_data` in an event of type `m.direct`. The
-  content of this event is an object where the keys are the user IDs
-  and values are lists of room ID strings of the 'direct' rooms for
-  that user ID.
-properties:
-  content:
-    patternProperties:
-      "^@":
-        x-pattern-format: mx-user-id
-        type: array
-        items:
-          type: string
-    type: object
-    description: |-
-      The mapping of user ID to a list of room IDs of the 'direct' rooms for
-      that user ID.
-  type:
-    enum:
-      - m.direct
-    type: string
-title: Direct Chat Mapping
-type: object

data/data/matrix-spec/event-schemas/schema/m.fully_read.yaml

@@ -1,26 +0,0 @@
-{
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "type": "object",
-    "title": "Read Marker Location Event",
-    "description": "The current location of the user's read marker in a room. This event appears in the user's room account data for the room the marker is applicable for.",
-    "allOf": [{
-        "$ref": "core-event-schema/event.yaml"
-    }],
-    "properties": {
-        "content": {
-            "type": "object",
-            "properties": {
-                "event_id": {
-                    "type": "string",
-                    "description": "The event the user's read marker is located at in the room."
-                }
-            },
-            "required": ["event_id"]
-        },
-        "type": {
-            "type": "string",
-            "enum": ["m.fully_read"]
-        }
-    },
-    "required": ["type", "content"]
-}

data/data/matrix-spec/event-schemas/schema/m.identity_server.yaml

@@ -1,28 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-allOf:
-  - $ref: core-event-schema/event.yaml
-description: |-
-  Persists the user's preferred identity server, or preference to not use
-  an identity server at all, in the user's account data.
-properties:
-  content:
-    type: object
-    properties:
-      base_url:
-        anyOf:
-          - type: string
-            format: uri
-          - type: "null"
-        description: |-
-          The URL of the identity server the user prefers to use, or `null`
-          if the user does not want to use an identity server. This value is
-          similar in structure to the `base_url` for identity servers in the
-          `.well-known/matrix/client` schema.
-  type:
-    enum:
-      - m.identity_server
-    type: string
-title: Identity Server Preference
-type: object

data/data/matrix-spec/event-schemas/schema/m.ignored_user_list.yaml

@@ -1,30 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-allOf:
-  - $ref: core-event-schema/event.yaml
-description: |-
-  A map of users which are considered ignored is kept in `account_data`
-  in an event type of `m.ignored_user_list`.
-properties:
-  content:
-    type: object
-    properties:
-      ignored_users:
-        type: object
-        description: |-
-          The map of users to ignore. This is a mapping of user ID to empty
-          object.
-        patternProperties:
-          "^@":
-            type: "object"
-            description: "An empty object for future enhancement"
-            x-pattern-format: "mx-user-id"
-    required:
-      - ignored_users
-  type:
-    enum:
-      - m.ignored_user_list
-    type: string
-title: Ignored User List
-type: object

data/data/matrix-spec/event-schemas/schema/m.invite_permission_config.yaml

@@ -1,21 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-allOf:
-  - $ref: core-event-schema/event.yaml
-  - title: Invite Permission
-    type: object
-    description: |-
-      The permission configuration for receiving invites for the current account.
-    properties:
-      content:
-        type: object
-        properties:
-          default_action:
-            type: string
-            description: |-
-              When set to `block`, the user does not wish to receive *any* room invites, and they
-              should be rejected automatically by the homeserver.
-
-              A missing, invalid or unsupported value means that the user wants to receive invites
-              as normal. Other parts of the specification might still have effects on invites, like
-              [ignoring users](/client-server-api/#ignoring-users).

data/data/matrix-spec/event-schemas/schema/m.marked_unread.yaml

@@ -1,26 +0,0 @@
-{
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "type": "object",
-    "title": "Unread Marker Event",
-    "description": "The current state of the user's unread marker in a room. This event appears in the user's room account data for the room the marker is applicable for.",
-    "allOf": [{
-        "$ref": "core-event-schema/event.yaml"
-    }],
-    "properties": {
-        "content": {
-            "type": "object",
-            "properties": {
-                "unread": {
-                    "type": "boolean",
-                    "description": "Whether the room is marked unread or not."
-                }
-            },
-            "required": ["unread"]
-        },
-        "type": {
-            "type": "string",
-            "enum": ["m.marked_unread"]
-        }
-    },
-    "required": ["type", "content"]
-}

data/data/matrix-spec/event-schemas/schema/m.policy.rule.room.yaml

@@ -1,17 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-allOf:
-  - $ref: core-event-schema/state_event.yaml
-description: A moderation policy rule which affects room IDs and room aliases.
-properties:
-  content:
-    $ref: "../moderation_policy_rule.yaml"
-  state_key:
-    description: An arbitrary string decided upon by the sender.
-    type: string
-  type:
-    enum:
-      - m.policy.rule.room
-    type: string
-type: object

data/data/matrix-spec/event-schemas/schema/m.policy.rule.server.yaml

@@ -1,17 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-allOf:
-  - $ref: core-event-schema/state_event.yaml
-description: A moderation policy rule which affects servers.
-properties:
-  content:
-    $ref: "../moderation_policy_rule.yaml"
-  state_key:
-    description: An arbitrary string decided upon by the sender.
-    type: string
-  type:
-    enum:
-      - m.policy.rule.server
-    type: string
-type: object

data/data/matrix-spec/event-schemas/schema/m.policy.rule.user.yaml

@@ -1,17 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-allOf:
-  - $ref: core-event-schema/state_event.yaml
-description: A moderation policy rule which affects users.
-properties:
-  content:
-    $ref: "../moderation_policy_rule.yaml"
-  state_key:
-    description: An arbitrary string decided upon by the sender.
-    type: string
-  type:
-    enum:
-      - m.policy.rule.user
-    type: string
-type: object

data/data/matrix-spec/event-schemas/schema/m.presence.yaml

@@ -1,50 +0,0 @@
-{
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "type": "object",
-    "title": "Presence Event",
-    "description": "Informs the client of a user's presence state change.",
-    "allOf": [{
-        "$ref": "core-event-schema/event.yaml"
-    }],
-    "properties": {
-        "content": {
-            "type": "object",
-            "properties": {
-                "avatar_url": {
-                    "type": "string",
-                    "description": "The current avatar URL for this user, if any."
-                },
-                "displayname": {
-                    "type": "string",
-                    "description": "The current display name for this user, if any."
-                },
-                "last_active_ago": {
-                    "type": "number",
-                    "description": "The last time since this used performed some action, in milliseconds."
-                },
-                "presence": {
-                    "type": "string",
-                    "description": "The presence state for this user.",
-                    "enum": ["online", "offline", "unavailable"]
-                },
-                "currently_active": {
-                    "type": boolean,
-                    "description": "Whether the user is currently active"
-                },
-                "status_msg": {
-                    "type": "string",
-                    "description": "An optional description to accompany the presence."
-                }
-            },
-            "required": ["presence"]
-        },
-        "type": {
-            "type": "string",
-            "enum": ["m.presence"]
-        },
-        "sender": {
-            "type": "string"
-        }
-    },
-    "required": ["sender", "type", "content"]
-}

data/data/matrix-spec/event-schemas/schema/m.push_rules.yaml

@@ -1,23 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-allOf:
-  - $ref: core-event-schema/event.yaml
-description: Describes all push rules for this user.
-properties:
-  content:
-    properties:
-      global:
-        type: object
-        title: Ruleset
-        description: The global ruleset
-        allOf:
-          - $ref: ../../api/client-server/definitions/push_ruleset.yaml
-    type: object
-  type:
-    enum:
-      - m.push_rules
-    type: string
-title: Push rules
-type: object
-