You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
86 lines
2.6 KiB
YAML
86 lines
2.6 KiB
YAML
# Copyright 2016 OpenMarket 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.
|
|
|
|
title: PushRule
|
|
type: object
|
|
properties:
|
|
actions:
|
|
items:
|
|
type:
|
|
- object
|
|
- string
|
|
type: array
|
|
description: |-
|
|
The actions to perform when this rule is matched.
|
|
default:
|
|
type: boolean
|
|
description: |-
|
|
Whether this is a default rule, or has been set explicitly.
|
|
enabled:
|
|
type: boolean
|
|
description: |-
|
|
Whether the push rule is enabled or not.
|
|
rule_id:
|
|
type: string
|
|
description: |-
|
|
The ID of this rule.
|
|
conditions:
|
|
type: array
|
|
items:
|
|
title: PushCondition
|
|
type: object
|
|
properties:
|
|
kind:
|
|
enum:
|
|
- event_match
|
|
- contains_display_name
|
|
- room_member_count
|
|
type: string
|
|
key:
|
|
type: string
|
|
description: |-
|
|
Required for ``event_match`` conditions. The dot-separated field of the
|
|
event to match.
|
|
x-example: content.body
|
|
pattern:
|
|
type: string
|
|
description: |-
|
|
Required for ``event_match`` conditions. The glob-style pattern to
|
|
match against. Patterns with no special glob characters should be
|
|
treated as having asterisks prepended and appended when testing the
|
|
condition.
|
|
is:
|
|
type: string
|
|
description: |-
|
|
Required for ``room_member_count`` conditions. A decimal integer
|
|
optionally prefixed by one of, ==, <, >, >= or <=. A prefix of < matches
|
|
rooms where the member count is strictly less than the given number and
|
|
so forth. If no prefix is present, this parameter defaults to ==.
|
|
required:
|
|
- kind
|
|
description: |-
|
|
The conditions that must hold true for an event in order for a rule to be
|
|
applied to an event. A rule with no conditions always matches. Only
|
|
applicable to ``underride`` and ``override`` rules.
|
|
pattern:
|
|
type: string
|
|
description: |-
|
|
The glob-style pattern to match against. Only applicable to ``content``
|
|
rules.
|
|
required:
|
|
- actions
|
|
- default
|
|
- enabled
|
|
- rule_id
|