Class PushProcessor

Hierarchy

  • PushProcessor

Constructors

constructor

Properties

client cachedGlobToRegex

Methods

actionsForEvent createCachedRegex eventFulfillsCallStartedCondition eventFulfillsCondition eventFulfillsDisplayNameCondition eventFulfillsEventMatchCondition eventFulfillsRoomMemberCountCondition eventFulfillsSenderNotifPermCondition getPushRuleById matchingRuleForEventWithRulesets matchingRuleFromKindSet pushActionsForEventAndRulesets ruleMatchesEvent templateRuleToRaw valueForDottedKey actionListToActionsObject rewriteDefaultRules

Constructors

constructor

Properties

Private Readonly client

client: MatrixClient

The Matrix client object to use

Static Private cachedGlobToRegex

cachedGlobToRegex: Record<string, RegExp> = {}

Methods

actionsForEvent

Private createCachedRegex

  • Parameters

    • prefix: string
    • glob: string
    • suffix: string

    Returns RegExp

Private eventFulfillsCallStartedCondition

Private eventFulfillsCondition

Private eventFulfillsDisplayNameCondition

Private eventFulfillsEventMatchCondition

Private eventFulfillsRoomMemberCountCondition

Private eventFulfillsSenderNotifPermCondition

getPushRuleById

  • Get one of the users push rules by its ID

    Returns

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

    Parameters

    • ruleId: string

      The ID of the rule to search for

    Returns null | IPushRule

Private matchingRuleForEventWithRulesets

Private matchingRuleFromKindSet

Private pushActionsForEventAndRulesets

ruleMatchesEvent

Private templateRuleToRaw

Private valueForDottedKey

Static actionListToActionsObject

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

    Example

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

    Returns

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

    Parameters

    Returns IActionsObject

Static rewriteDefaultRules

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

    Returns

    The rewritten rules

    Parameters

    • incomingRules: IPushRules

      The client's existing push rules

    Returns IPushRules

Settings

Member Visibility

Theme

Generated using TypeDoc