FMPPush

interface FMPPush : FMPObject

Представляет собой PUSH уведомления.

Since

21.04.01

Samples

import ru.fsight.fmp.FMP
import ru.fsight.fmp.FMPPush
fun main() { 
   //sampleStart 
   /*
 * Пример создания FMPPush.
 */
val push: FMPPush = fmp.push // Создать Builder.
	.token(firebaseToken)      // Указать токен Firebase.
	.build()                   // Создать FMPPush. 
   //sampleEnd
}
import ru.fsight.fmp.FMP
import ru.fsight.fmp.FMPPush
fun main() { 
   //sampleStart 
   /*
 * Пример работы с топиками и токенами.
 */
val topics: List<FMPPush.Topic> = push.getTopics().result // Получить список доступных топиков.
val tokens: List<FMPPush.Token> = push.getTokens().result // Получить список токенов текущего устройства с сервера.

val is_added:   Boolean = push.submitToken().result // True если токен был добавлен на сервер.
val is_removed: Boolean = push.revokeToken().result // True если токен был удалён с сервера.

val is_subscribed:   Boolean = push.subscribe(listOf("topic")).result   // True подписался на все топики.
val is_unsubscribed: Boolean = push.unsubscribe(listOf("topic")).result // True если отписался от всех топиков. 
   //sampleEnd
}
import ru.fsight.fmp.FMP
import ru.fsight.fmp.FMPPush
fun main() { 
   //sampleStart 
   /*
 * Пример отправки пуш-уведомления пользователю или группе пользователей через топик.
 * Содержимое сообщения зависит от содержимого шаблона.
 */
val title   = "Сообщение от пользователя test"
val message = "Тут лес вокруг!"
push.sendToUser("template", "username", "{\"title\":\"$title\",\"body\":\"$message\"}") // Отправить сообщение пользователю username.
push.sendToTopic("template", "topic", "{\"title\":\"$title\",\"body\":\"$message\"}")   // Отправить сообщение пользователям подписанным на топик topic. 
   //sampleEnd
}

Types

Link copied to clipboard
Link copied to clipboard
object Companion
Link copied to clipboard
data class Token

Представляет собой описание токена, полученного с сервера.

Link copied to clipboard
data class Topic

Представляет собой описание топика, полученное с сервера.

Properties

Link copied to clipboard
abstract val service: String

Используемый сервис PUSH-уведомлений. По умолчанию SERVICE_FIREBASE.

Link copied to clipboard
abstract val token: String

Токен устройства.

Functions

Link copied to clipboard
abstract operator override fun equals(other: Any?): Boolean

Сравнить объекты между собой.

Link copied to clipboard

Получить список токенов на сервере, принадлежащих текущему пользователю.

Link copied to clipboard

Получить список доступных пользователю топиков.

Link copied to clipboard
abstract override fun hashCode(): Int

Хэш-код объектов. В отличие от equals он будет одинаков для объектов с одинаковыми ключевыми параметрами, но созданными от разных объектов FMP.

Link copied to clipboard
abstract override fun rebuild(): FMPPush.Builder
Link copied to clipboard
abstract fun revokeToken(): FMPResult<Boolean>

Удалить token с сервера.

Link copied to clipboard
abstract fun sendToTopic(template: String, topic: String, data: String): FMPResult<Boolean>

Отправить пуш группе пользователей по топику.

Link copied to clipboard
abstract fun sendToUser(template: String, user: String, data: String): FMPResult<Boolean>

Отправить пуш конкретному пользователю.

Link copied to clipboard
abstract fun submitToken(): FMPResult<Boolean>

Отправить token устройства на сервер.

Link copied to clipboard
abstract fun subscribe(topics: List<String>): FMPResult<Boolean>

Подписаться на topics на сервере.

Link copied to clipboard
abstract override fun toString(): String

Получить ключевые параметры объекта в виде строки.

Link copied to clipboard
abstract fun unsubscribe(topics: List<String>): FMPResult<Boolean>

Отписаться от topics на сервере.