91 lines
2.7 KiB
TypeScript
91 lines
2.7 KiB
TypeScript
/*
|
|
Copyright 2016 OpenMarket Ltd
|
|
Copyright 2019, 2020 The Matrix.org Foundation C.I.C.
|
|
|
|
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.
|
|
*/
|
|
|
|
import {StandardActions} from "./StandardActions";
|
|
import {NotificationUtils} from "./NotificationUtils";
|
|
import {IPushRule} from "./types";
|
|
|
|
export enum State {
|
|
/** The push rule is disabled */
|
|
Off = "off",
|
|
/** The user will receive push notification for this rule */
|
|
On = "on",
|
|
/** The user will receive push notification for this rule with sound and
|
|
highlight if this is legitimate */
|
|
Loud = "loud",
|
|
}
|
|
|
|
export class PushRuleVectorState {
|
|
// Backwards compatibility (things should probably be using the enum above instead)
|
|
static OFF = State.Off;
|
|
static ON = State.On;
|
|
static LOUD = State.Loud;
|
|
|
|
/**
|
|
* Enum for state of a push rule as defined by the Vector UI.
|
|
* @readonly
|
|
* @enum {string}
|
|
*/
|
|
static states = State;
|
|
|
|
/**
|
|
* Convert a PushRuleVectorState to a list of actions
|
|
*
|
|
* @return [object] list of push-rule actions
|
|
*/
|
|
static actionsFor(pushRuleVectorState: State) {
|
|
if (pushRuleVectorState === State.On) {
|
|
return StandardActions.ACTION_NOTIFY;
|
|
} else if (pushRuleVectorState === State.Loud) {
|
|
return StandardActions.ACTION_HIGHLIGHT_DEFAULT_SOUND;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Convert a pushrule's actions to a PushRuleVectorState.
|
|
*
|
|
* Determines whether a content rule is in the PushRuleVectorState.ON
|
|
* category or in PushRuleVectorState.LOUD, regardless of its enabled
|
|
* state. Returns null if it does not match these categories.
|
|
*/
|
|
static contentRuleVectorStateKind(rule: IPushRule): State {
|
|
const decoded = NotificationUtils.decodeActions(rule.actions);
|
|
|
|
if (!decoded) {
|
|
return null;
|
|
}
|
|
|
|
// Count tweaks to determine if it is a ON or LOUD rule
|
|
let tweaks = 0;
|
|
if (decoded.sound) {
|
|
tweaks++;
|
|
}
|
|
if (decoded.highlight) {
|
|
tweaks++;
|
|
}
|
|
let stateKind = null;
|
|
switch (tweaks) {
|
|
case 0:
|
|
stateKind = State.On;
|
|
break;
|
|
case 2:
|
|
stateKind = State.Loud;
|
|
break;
|
|
}
|
|
return stateKind;
|
|
}
|
|
}
|