matrix-spec/api/server-server/definitions/event-schemas/m.presence.deny.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: Presence Invite Deny EDU
description: |-
  An EDU representing a declination or revocation for the observing user
  to subscribe to the presence of the observed user.
example: {
  "origin": "domain.com",
  "destination": "elsewhere.org",
  "edu_type": "m.presence_deny",
  "content": {
    "observed_user": "@alice:elsewhere.org",
    "observer_user": "@john:domain.com"
  }
}
allOf:
  - $ref: ../edu.yaml
  - type: object
    properties:
      edu_type:
        type: enum
        enum: ['m.presence_deny']
        description: The string ``m.presence_deny``
        example: "m.presence_deny"
      content:
        type: object
        description: The invite information.
        title: Invite Information
        properties:
          observed_user:
            type: string
            description: |-
              The user ID that has declined or revoked the ``observer_user`` from
              subscribing to their presence.
            example: "@alice:elsewhere.com"
          observer_user:
            type: string
            description: |-
              The user ID that requested to subscribe to the presence of
              the ``observed_user``.
            example: "@john:matrix.org"
        required: ['observer_user', 'observed_user']