mobile-push
API
Generated with
mobile-push/com.malliina.push.apns

com.malliina.push.apns

package com.malliina.push.apns

Members list

Concise view

Type members

Classlikes

object APNSCertClient

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
class APNSCertClient(socketFactory: SSLSocketFactory, isSandbox: Boolean) extends APNSHttpClient with AutoCloseable

Attributes

Companion:
object
Graph
Supertypes
trait AutoCloseable
class APNSHttpClientBase[Future]
class Object
trait Matchable
class Any
case object APNSConsiderate extends APNSPriority

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
sealed abstract class APNSError(val reason: String, val description: String)

Attributes

See also:
Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object BadCertificate.type
object BadCollapseId.type
object BadDeviceToken.type
object BadExpirationDate.type
object BadMessageId.type
object BadPath.type
object BadPriority.type
object BadTopic.type
object DuplicateHeaders.type
object Forbidden.type
object IdleTimeout.type
object MethodNotAllowed.type
object MissingDeviceToken.type
object MissingTopic.type
object PayloadEmpty.type
object PayloadTooLarge.type
object ServiceUnavailable.type
object Shutdown.type
object TooManyRequests.type
object TopicDisallowed.type
object UnknownReason.type
object Unregistered.type
object APNSError extends OpenEnum[APNSError]

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class APNSErrorJson(reason: APNSError)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object APNSErrorJson

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object APNSHttpClient

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
class APNSHttpClient(val client: OkClient, prep: RequestPreparer, isSandbox: Boolean) extends APNSHttpClientBase[Future]

APNs client, using the HTTP/2 notification API.

APNs client, using the HTTP/2 notification API.

Uses OkHttp with Jetty's "alpn-boot" in the bootclasspath for HTTP/2 support; please check the build definition of this project for details.

Attributes

See also:
Companion:
object
Graph
Supertypes
class APNSHttpClientBase[Future]
class Object
trait Matchable
class Any
Known subtypes
abstract class APNSHttpClientBase[F[_]](http: HttpClient[F], prep: RequestPreparer, isSandbox: Boolean) extends PushClientF[APNSToken, APNSRequest, Either[APNSError, APNSIdentifier], F]

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class APNSHttpResult(token: APNSToken, id: Option[APNSIdentifier], error: Option[APNSError])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object APNSHttpResult

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class APNSIdentifier(id: String) extends AnyVal

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
object APNSIdentifier extends SimpleCompanion[String, APNSIdentifier]

Attributes

Companion:
class
Graph
Supertypes
class ValidatingCompanion[String, APNSIdentifier]
class Object
trait Matchable
class Any
Self type
case object APNSImmediately extends APNSPriority

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
case class APNSMessage(aps: APSPayload, data: Map[String, Json])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object APNSMessage

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class APNSMeta(apnsTopic: APNSTopic, apnsExpiration: Long, apnsPriority: APNSPriority, apnsPushType: APNSPushType, apnsId: Option[APNSIdentifier])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object APNSMeta

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class APNSPriority(val priority: Int)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object APNSConsiderate.type
object APNSImmediately.type
object APNSPriority extends ValidatingCompanion[Int, APNSPriority]

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class ValidatingCompanion[Int, APNSPriority]
class Object
trait Matchable
class Any
Self type
sealed abstract class APNSPushType(val name: String)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Alert.type
object Background.type
object APNSPushType extends StringEnumCompanion[APNSPushType]

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class StringEnumCompanion[APNSPushType]
class EnumCompanion[String, APNSPushType]
class ValidatingCompanion[String, APNSPushType]
class Object
trait Matchable
class Any
Self type
case class APNSRequest(message: APNSMessage, meta: APNSMeta)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object APNSRequest

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class APNSToken(token: String) extends AnyVal with Token

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Token
class AnyVal
trait Matchable
class Any
object APNSToken extends TokenCompanion[APNSToken]

Attributes

Companion:
class
Graph
Supertypes
class SimpleCompanion[String, APNSToken]
class ValidatingCompanion[String, APNSToken]
class Object
trait Matchable
class Any
Self type
object APNSTokenClient

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class APNSTokenConf(privateKey: PKCS8EncodedKeySpec, keyId: KeyId, teamId: TeamId)

Attributes

privateKey

downloadable from Apple's developer website

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object APNSTokenConf extends ConfHelper[APNSTokenConf]

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object APNSTokenPreparer

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
class APNSTokenPreparer(conf: APNSTokenConf) extends RequestPreparer

For security, APNs requires you to refresh your token regularly. Refresh your token no more than once every 20 minutes and no less than once every 60 minutes. APNs rejects any request whose token contains a timestamp that is more than one hour old. Similarly, APNs reports an error if you recreate your tokens more than once every 20 minutes.

For security, APNs requires you to refresh your token regularly. Refresh your token no more than once every 20 minutes and no less than once every 60 minutes. APNs rejects any request whose token contains a timestamp that is more than one hour old. Similarly, APNs reports an error if you recreate your tokens more than once every 20 minutes.

On your provider server, set up a recurring task to recreate your token with a current timestamp. Encrypt the token again and attach it to subsequent notification requests.

Attributes

See also:
Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
final case class APNSTopic(topic: String) extends AnyVal

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
object APNSTopic extends SimpleCompanion[String, APNSTopic]

Attributes

Companion:
class
Graph
Supertypes
class SimpleCompanion[String, APNSTopic]
class ValidatingCompanion[String, APNSTopic]
class Object
trait Matchable
class Any
Self type
case class APSPayload(alert: Option[Either[String, AlertPayload]], badge: Option[Int], sound: Option[String], category: Option[String], threadId: Option[String])

Attributes

alert

Some(Left(...)) for a simple alert text, Some(Right(...)) for more verbose alert details, None for background notifications

badge

badge number

sound

rock.mp3

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object APSPayload

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case object Alert extends APNSPushType

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
Alert.type
case class AlertPayload(body: String, title: Option[String], launchImage: Option[String], actionLocKey: Option[String], locKey: Option[String], locArgs: Option[Seq[String]], titleLocKey: Option[String], titleLocArgs: Option[Seq[String]])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object AlertPayload

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case object Background extends APNSPushType

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
case object BadCertificate extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object BadCertificateEnvironment extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object BadCollapseId extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object BadDeviceToken extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object BadExpirationDate extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object BadMessageId extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object BadPath extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
BadPath.type
case object BadPriority extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object BadTopic extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object DeviceTokenNotForTopic extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object DuplicateHeaders extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object ExpiredProviderToken extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object Forbidden extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object IdleTimeout extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case class InactiveDevice(deviceHexID: String, asOf: Long)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case object InternalServerError extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object InvalidProviderToken extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
final case class KeyId(id: String) extends AnyVal

Apple Developer Key ID.

Apple Developer Key ID.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
case object MethodNotAllowed extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object MissingDeviceToken extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object MissingProviderToken extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object MissingTopic extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case class OtherReason(r: String) extends APNSError

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
case object PayloadEmpty extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object PayloadTooLarge extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
trait RequestPreparer

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object RequestPreparer

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case object ServiceUnavailable extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object Shutdown extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
final case class TeamId(team: String) extends AnyVal

Apple Team ID.

Apple Team ID.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
case object TooManyProviderTokenUpdates extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object TooManyRequests extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object TopicDisallowed extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object UnknownReason extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
case object Unregistered extends APNSError

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class APNSError
class Object
trait Matchable
class Any
Self type
Generated with