APNPayload

public class APNPayload

Representation of the server push notification payload.

Getting payload in other formats
  • payloadDictionary

    Dictionary representation of the payload

    Declaration

    Swift

    public var payloadDictionary: [AnyHashable : Any]
  • payloadJSON

    JSON (SwiftyJSON) representation of the payload

    Declaration

    Swift

    public var payloadJSON: JSON { get }

Initializing
  • init(dictionary:)

    Initialize a APNPayload with a server notification payload dictionary.

    Declaration

    Swift

    public init(dictionary: [AnyHashable : Any])
    Parameters
    dictionary

    Dictionary representation of the payload

Accessing values from the payload
  • subscript(_:)

    A way to access values of the APNPayload instance using subscripts

    Declaration

    Swift

    public subscript(path: String) -> Any? { get }
    Parameters
    path

    Key path
  • messageType

    Notification message type raw value

    Declaration

    Swift

    public var messageType: Int { get }
  • message

    Notification message

    Declaration

    Swift

    public var message: String? { get }
  • apsDictionary

    APS Dictionary

    Declaration

    Swift

    public var apsDictionary: [String : Any?]? { get }
  • apsCategory

    APS notification category

    Declaration

    Swift

    public var apsCategory: String? { get }
  • alertDictionary

    APS alert dictionary

    Declaration

    Swift

    public var alertDictionary: [String : Any?]? { get }
  • alertTitle

    APS alert title

    Declaration

    Swift

    public var alertTitle: String? { get }
  • alertBody

    APS alert body

    Declaration

    Swift

    public var alertBody: String? { get }
  • isSilentNotification

    A boolean value indicating whether the notificaiton is silent

    Declaration

    Swift

    public var isSilentNotification: Bool { get }
  • infoDictionary

    Usher Server notification info dictionary

    Declaration

    Swift

    public var infoDictionary: [String : Any?]? { get }
  • infoOrgId

    Usher Server notification info organization Id

    Declaration

    Swift

    public var infoOrgId: String? { get }
  • infoOrgName

    Usher Server notification info organization name

    Declaration

    Swift

    public var infoOrgName: String? { get }
  • infoBadgeId

    Usher Server notification info badge ID

    Declaration

    Swift

    public var infoBadgeId: String? { get }
  • infoComputerGUID

    Usher Server notification info computer GUID

    Declaration

    Swift

    public var infoComputerGUID: String? { get }
  • infoSessionId

    Usher Server notification info session ID

    Declaration

    Swift

    public var infoSessionId: String? { get }
  • infoClientName

    Usher Server notification info client name

    Declaration

    Swift

    public var infoClientName: String? { get }
  • infoClientId

    Usher Server notification info client ID

    Declaration

    Swift

    public var infoClientId: String? { get }
  • infoQrCode

    Usher Server notification info QR code

    Declaration

    Swift

    public var infoQrCode: String? { get }
  • infoOtpCode

    Usher Server notification info OTP code

    Declaration

    Swift

    public var infoOtpCode: String? { get }
  • infoServerPort

    Usher Server notification info server port number

    Declaration

    Swift

    public var infoServerPort: String? { get }
  • infoServerHost

    Usher Server notification info server host address

    Declaration

    Swift

    public var infoServerHost: String? { get }
  • infoSystemName

    Usher Server notification info system name

    Declaration

    Swift

    public var infoSystemName: String? { get }
  • infoAppName

    Usher Server notification info application name

    Declaration

    Swift

    public var infoAppName: String? { get }
  • infoTime

    Usher Server notification info time

    Declaration

    Swift

    public var infoTime: TimeInterval { get }
  • pairingId

    Usher Server notification desktop pairing ID.

    Declaration

    Swift

    public var pairingId: String? { get }
  • code

    Usher Server notification desktop code.

    Declaration

    Swift

    public var code: String? { get }
  • isBluetoothOn

    Boolean indicating if bluetooth unlock is enabled on Usher desktop.

    Declaration

    Swift

    public var isBluetoothOn: Bool { get }
  • sessionId

    Usher Server notification desktop unlock session ID.

    Declaration

    Swift

    public var sessionId: String? { get }
  • computerGuid

    Usher Server notification desktop computer GUID.

    Declaration

    Swift

    public var computerGuid: String? { get }
  • resultDictionary

    Usher Desktop action result dictionary.

    Declaration

    Swift

    public var resultDictionary: [String : Any?]? { get }
  • resultEvent

    Usher Desktop action result event type.

    Declaration

    Swift

    public var resultEvent: String? { get }
  • resultMessage

    Usher Desktop action result message.

    Declaration

    Swift

    public var resultMessage: String? { get }
  • resultComputerName

    Usher Desktop action result computer name.

    Declaration

    Swift

    public var resultComputerName: String? { get }
  • notificationOnly

    A boolean value indicating the notification’s actions should not be handled.

    Declaration

    Swift

    public var notificationOnly: Bool { get }