Class PushDecision

What the push rules say about one event for one user: whether it counts as a notification, and whether it is highlighted, e.g. as a mention.

Inheritance

object

PushDecision

Implements

IEquatable<PushDecision>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.Protocol.Server

Assembly: Uniform.Matrix.Protocol.Server.dll

Syntax

public sealed record PushDecision : IEquatable<PushDecision>

Constructors

PushDecision(bool, bool, string?)

What the push rules say about one event for one user: whether it counts as a notification, and whether it is highlighted, e.g. as a mention.

Declaration

public PushDecision(bool Notify, bool Highlight, string? RuleId)

Parameters

Type	Name	Description
bool	Notify	Whether the event notifies, counting in notification_count.
bool	Highlight	Whether it is highlighted, counting in highlight_count too.
string	RuleId	The rule that decided, or null when none matched.

Properties

Highlight

Whether it is highlighted, counting in highlight_count too.

Declaration

public bool Highlight { get; init; }

Property Value

Type	Description
bool

None

No rule matched: nothing happens.

Declaration

public static PushDecision None { get; }

Property Value

Type	Description
PushDecision

Notify

Whether the event notifies, counting in notification_count.

Declaration

public bool Notify { get; init; }

Property Value

Type	Description
bool

RuleId

The rule that decided, or null when none matched.

Declaration

public string? RuleId { get; init; }

Property Value

Type	Description
string

Tweaks

Tweaks of the deciding rule's actions by name, e.g. sound: default, as push gateways receive them.

Declaration

public IReadOnlyDictionary<string, JsonNode?> Tweaks { get; init; }

Property Value

Type	Description
IReadOnlyDictionary<string, JsonNode>

Implements

IEquatable<T>