Class PushProcessor

Index

Constructors

Methods

actionsAndRuleForEvent actionsForEvent getPushRuleAndKindById getPushRuleById ruleMatchesEvent updateCachedPushRuleKeys actionListToActionsObject partsForDottedKey rewriteDefaultRules

Constructors

constructor

new PushProcessor(client: MatrixClient): PushProcessor
Construct a Push Processor.
Parameters
- client: MatrixClient
  The Matrix client object to use
Returns PushProcessor
- Defined in src/pushprocessor.ts:243

Methods

actionsAndRuleForEvent

actionsAndRuleForEvent(
ev: MatrixEvent,
): { actions?: IActionsObject; rule?: IAnnotatedPushRule }
Parameters
- ev: MatrixEvent
Returns { actions?: IActionsObject; rule?: IAnnotatedPushRule }
- Defined in src/pushprocessor.ts:798

actionsForEvent

actionsForEvent(ev: MatrixEvent): IActionsObject
Get the user's push actions for the given event
Parameters
- ev: MatrixEvent
Returns IActionsObject
- Defined in src/pushprocessor.ts:793

getPushRuleAndKindById

getPushRuleAndKindById(
ruleId: string,
): 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
- Defined in src/pushprocessor.ts:823

getPushRuleById

getPushRuleById(ruleId: string): 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
- Defined in src/pushprocessor.ts:811

ruleMatchesEvent

ruleMatchesEvent(
rule: Partial<IPushRule> & Pick<IPushRule, "conditions">,
ev: MatrixEvent,
): boolean
Parameters
- rule: Partial<IPushRule> & Pick<IPushRule, "conditions">
- ev: MatrixEvent
Returns boolean
- Defined in src/pushprocessor.ts:775

updateCachedPushRuleKeys

updateCachedPushRuleKeys(newRules: IPushRules): 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
- newRules: IPushRules
  The new push rules.
Returns void
- Defined in src/pushprocessor.ts:316

`Static`actionListToActionsObject

actionListToActionsObject(actionList: PushRuleAction[]): IActionsObject
Convert a list of actions into a object with the actions as keys and their values
Parameters
- actionList: PushRuleAction[]
  The actions list
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' } }`
```
- Defined in src/pushprocessor.ts:260

`Static`partsForDottedKey

partsForDottedKey(str: string): 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.
- Defined in src/pushprocessor.ts:643

`Static`rewriteDefaultRules

rewriteDefaultRules(
incomingRules: IPushRules,
userId?: undefined | string,
): 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
- Defined in src/pushprocessor.ts:283