Class PushProcessor

Constructors

constructor

Properties

client parsedKeys cachedGlobToRegex

Methods

actionsAndRuleForEvent actionsForEvent createCachedRegex eventFulfillsCallStartedCondition eventFulfillsCondition eventFulfillsDisplayNameCondition eventFulfillsEventMatchCondition eventFulfillsEventPropertyContains eventFulfillsEventPropertyIsCondition eventFulfillsRoomMemberCountCondition eventFulfillsSenderNotifPermCondition getPushRuleAndKindById getPushRuleById matchingRuleForEventWithRulesets matchingRuleFromKindSet pushActionsForEventAndRulesets ruleMatchesEvent templateRuleToRaw updateCachedPushRuleKeys valueForDottedKey actionListToActionsObject partsForDottedKey rewriteDefaultRules

Constructors

constructor

Properties

Private Readonly client

client: MatrixClient

The Matrix client object to use

Private Readonly parsedKeys

parsedKeys: Map<string, string[]> = ...

Maps the original key from the push rules to a list of property names after unescaping.

Static Private cachedGlobToRegex

cachedGlobToRegex: Record<string, RegExp> = {}

Methods

actionsAndRuleForEvent

actionsForEvent

Private createCachedRegex

Private eventFulfillsCallStartedCondition

Private eventFulfillsCondition

Private eventFulfillsDisplayNameCondition

Private eventFulfillsEventMatchCondition

  • eventFulfillsEventMatchCondition(cond, ev): boolean

  • Check whether the given event matches the push rule condition by fetching the property from the event and comparing against the condition's glob-based pattern.

    Parameters

    Returns boolean

Private eventFulfillsEventPropertyContains

  • eventFulfillsEventPropertyContains(cond, ev): boolean

  • Check whether the given event matches the push rule condition by fetching the property from the event and comparing exactly against the condition's value.

    Parameters

    Returns boolean

Private eventFulfillsEventPropertyIsCondition

  • eventFulfillsEventPropertyIsCondition(cond, ev): boolean

  • Check whether the given event matches the push rule condition by fetching the property from the event and comparing exactly against the condition's value.

    Parameters

    Returns boolean

Private eventFulfillsRoomMemberCountCondition

Private eventFulfillsSenderNotifPermCondition

getPushRuleAndKindById

  • getPushRuleAndKindById(ruleId): null | {
        kind: PushRuleKind;
        rule: IPushRule;
    }

  • Get one of the users push rules by its ID

    Parameters

    • ruleId: string

      The ID of the rule to search for

    Returns null | {
        kind: PushRuleKind;
        rule: IPushRule;
    }

    rule The push rule, or null if no such rule was found

getPushRuleById

  • getPushRuleById(ruleId): null | IPushRule

  • Get one of the users push rules by its ID

    Parameters

    • ruleId: string

      The ID of the rule to search for

    Returns null | IPushRule

    The push rule, or null if no such rule was found

Private matchingRuleForEventWithRulesets

Private matchingRuleFromKindSet

Private pushActionsForEventAndRulesets

ruleMatchesEvent

Private templateRuleToRaw

updateCachedPushRuleKeys

  • updateCachedPushRuleKeys(newRules): void

  • Pre-caches the parsed keys for push rules and cleans out any obsolete cache entries. Should be called after push rules are updated.

    Parameters

    Returns void

Private valueForDottedKey

  • valueForDottedKey(key, ev): any

  • For a dotted field and event, fetch the value at that position, if one exists.

    Parameters

    • key: string

      The key of the push rule condition: a dotted field to fetch.

    • ev: MatrixEvent

      The matrix event to fetch the field from.

    Returns any

    The value at the dotted path given by key.

Static actionListToActionsObject

  • actionListToActionsObject(actionList): IActionsObject

  • Convert a list of actions into a object with the actions as keys and their values

    Parameters

    Returns IActionsObject

    A object with key 'notify' (true or false) and an object of actions

    Example

    eg. `[ 'notify', { set_tweak: 'sound', value: 'default' } ]`
        becomes `{ notify: true, tweaks: { sound: 'default' } }`

Static partsForDottedKey

  • partsForDottedKey(str): string[]
  • Internal

    Parse the key into the separate fields to search by splitting on unescaped ".", and then removing any escape characters.

    Parameters

    • str: string

      The key of the push rule condition: a dotted field.

    Returns string[]

    The unescaped parts to fetch.

Static rewriteDefaultRules

  • rewriteDefaultRules(incomingRules, userId?): IPushRules

  • Rewrites conditions on a client's push rules to match the defaults where applicable. Useful for upgrading push rules to more strict conditions when the server is falling behind on defaults.

    Parameters

    • incomingRules: IPushRules

      The client's existing push rules

    • userId: undefined | string = undefined

      The Matrix ID of the client.

    Returns IPushRules

    The rewritten rules

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc