matrix-sdk-android/org.matrix.android.sdk.api.session.pushrules.rest/PushRule

PushRule

@JsonClass(generateAdapter = true)

data class PushRule(@Json(name = "actions") val actions: List<Any>, @Json(name = "default") val default: Boolean? = false, @Json(name = "enabled") val enabled: Boolean, @Json(name = "rule_id") val ruleId: String, @Json(name = "conditions") val conditions: List<PushCondition>? = null, @Json(name = "pattern") val pattern: String? = null)

Ref: https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-pushrules

Constructors

constructor(@Json(name = "actions") actions: List<Any>, @Json(name = "default") default: Boolean? = false, @Json(name = "enabled") enabled: Boolean, @Json(name = "rule_id") ruleId: String, @Json(name = "conditions") conditions: List<PushCondition>? = null, @Json(name = "pattern") pattern: String? = null)

Functions

fun PushRule.getActions(): List<Action>

fun getHighlight(): Boolean

Get the highlight status. As spec mentions assume false if no tweak present.

getNotificationSound

fun getNotificationSound(): String?

removeNotificationSound

fun removeNotificationSound(): PushRule

Remove the notification sound.

fun setHighlight(highlight: Boolean): PushRule

Set the highlight status.

setNotificationSound

fun setNotificationSound(): PushRule

Add the default notification sound.

fun setNotificationSound(sound: String): PushRule

Set the notification sound.

fun setNotify(notify: Boolean): PushRule

Set the notification status.

fun shouldNotify(): Boolean

Return true if the rule should highlight the event.

shouldNotNotify

fun shouldNotNotify(): Boolean

Return true if the rule should not highlight the event.

Properties

val actions: List<Any>

Required. The actions to perform when this rule is matched.

val conditions: List<PushCondition>? = null

The conditions that must hold true for an event in order for a rule to be applied to an event.

val default: Boolean? = false

Required. Whether this is a default rule, or has been set explicitly.

val enabled: Boolean

Required. Whether the push rule is enabled or not.

val pattern: String? = null

The glob-style pattern to match against. Only applicable to content rules.

val ruleId: String

Required. The ID of this rule.