Class PushProcessor

Constructors

constructor

Methods

actionsAndRuleForEvent actionsForEvent getPushRuleAndKindById getPushRuleById ruleMatchesEvent updateCachedPushRuleKeys actionListToActionsObject partsForDottedKey rewriteDefaultRules

Constructors

constructor

Methods

actionsAndRuleForEvent

actionsForEvent

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

ruleMatchesEvent

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

StaticactionListToActionsObject

  • 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' } }`

StaticpartsForDottedKey

  • 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.

StaticrewriteDefaultRules

  • 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

On This Page

Constructors
Methods