matrix-sdk-android/org.matrix.android.sdk.api.session.pushers/HttpPusher

HttpPusher

data class HttpPusher(val pushkey: String, val appId: String, val profileTag: String, val lang: String, val appDisplayName: String, val deviceDisplayName: String, val url: String, val enabled: Boolean, val deviceId: String, val append: Boolean, val withEventIdOnly: Boolean)

Constructors

HttpPusher

constructor(pushkey: String, appId: String, profileTag: String, lang: String, appDisplayName: String, deviceDisplayName: String, url: String, enabled: Boolean, deviceId: String, append: Boolean, withEventIdOnly: Boolean)

Properties

appDisplayName

val appDisplayName: String

A human readable string that will allow the user to identify what application owns this pusher.

append

val append: Boolean

If true, the homeserver should add another pusher with the given pushkey and App ID in addition to any others with different user IDs. Otherwise, the homeserver must remove any other pushers with the same App ID and pushkey for different users.

appId

val appId: String

The application id This is a reverse-DNS style identifier for the application. It is recommended that this end with the platform, such that different platform versions get different app identifiers. Max length, 64 chars.

deviceDisplayName

val deviceDisplayName: String

A human readable string that will allow the user to identify what device owns this pusher.

deviceId

val deviceId: String

The device ID of the session that registered the pusher.

enabled

val enabled: Boolean

Whether the pusher should actively create push notifications.

lang

val lang: String

The preferred language for receiving notifications (e.g. "en" or "en-US").

profileTag

val profileTag: String

This string determines which set of device specific rules this pusher executes.

pushkey

val pushkey: String

This is a unique identifier for this pusher. The value you should use for this is the routing or destination address information for the notification, for example, the APNS token for APNS or the Registration ID for GCM. If your notification client has no such concept, use any unique identifier. Max length, 512 chars.

url

val url: String

The URL to use to send notifications to. MUST be an HTTPS URL with a path of /_matrix/push/v1/notify.

withEventIdOnly

val withEventIdOnly: Boolean

true to limit the push content to only id and not message content Ref: https://matrix.org/docs/spec/push_gateway/r0.1.1#homeserver-behaviour