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

PushersService

interface PushersService
Content copied to clipboard

Functions

Link copied to clipboard
abstract suspend fun addEmailPusher(    email: String,     lang: String,     emailBranding: String,     appDisplayName: String,     deviceDisplayName: String,     append: Boolean = true)
Content copied to clipboard

Add a new Email pusher. Ref: https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-pushers-set

Link copied to clipboard
abstract suspend fun addHttpPusher(httpPusher: HttpPusher)
Content copied to clipboard

Add a new HTTP pusher. Ref: https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-pushers-set

Link copied to clipboard
abstract fun enqueueAddHttpPusher(httpPusher: HttpPusher): UUID
Content copied to clipboard

Enqueues a new HTTP pusher via the WorkManager API. Ref: https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-pushers-set

Link copied to clipboard
abstract fun getPushers(): List<Pusher>
Content copied to clipboard

Get the current pushers.

Link copied to clipboard
abstract fun getPushersLive(): LiveData<List<Pusher>>
Content copied to clipboard

Get the current pushers, as a LiveData.

Link copied to clipboard
abstract fun refreshPushers()
Content copied to clipboard

Refresh pushers from server state.

Link copied to clipboard
abstract suspend fun removeEmailPusher(email: String)
Content copied to clipboard

Remove an Email pusher.

Link copied to clipboard
abstract suspend fun removeHttpPusher(pushkey: String, appId: String)
Content copied to clipboard

Remove a Http pusher by its pushkey and appId.

Link copied to clipboard
abstract suspend fun removePusher(pusher: Pusher)
Content copied to clipboard

Remove a registered pusher.

Link copied to clipboard
abstract suspend fun testPush(    url: String,     appId: String,     pushkey: String,     eventId: String)
Content copied to clipboard

Directly ask the push gateway to send a push to this device. If successful, the push gateway has accepted the request. In this case, the app should receive a Push with the provided eventId. In case of error, PusherRejected will be thrown. In this case it means that the pushkey is not valid.

Link copied to clipboard
abstract suspend fun togglePusher(pusher: Pusher, enable: Boolean)
Content copied to clipboard

Enables or disables a registered pusher.