Models

  • APN

    Representation of a server push notification that is used to parse the notification’s payload, category and type.

    Declaration

    Swift

    public class APN
  • Representation of the server push notification payload.

    Declaration

    Swift

    public class APNPayload
  • A QR or bar code scan entry in the scan history.

    Declaration

    Swift

    public class ScanLogEntry : ModelObject
  • Class representing the badge used for QR or bar code scanning

    Declaration

    Swift

    public class ScanLogBadge : ModelObject
  • The root class of all model objects.

    Inherits from:

    RealmSwift’s Object

    Conforms to:

    Mappable

    Declaration

    Swift

    public class ModelObject : Object, Mappable
  • Representation of a device the app is running on.

    Remark

    This class can only be initialized once per server. Use the factory method deviceForServer(_:) to get an already created instance or create one if there is no device object instance created already.
    Declaration

    Swift

    public class Device : ModelObject
  • A device that is provisioned to use a badge. Unline its super class, Device, serveral ProvisionedDevice objects can be initialized and used.

    Declaration

    Swift

    public class ProvisionedDevice : Device
  • Representation of an Usher Server.

    Declaration

    Swift

    public class Server : ModelObject
  • Representation of an Usher Badge.

    Declaration

    Swift

    public class Badge : ModelObject
  • Key

    Representation of a physical access key.

    Declaration

    Swift

    public class Key : ModelObject
  • Representation of a physical access key container.

    Declaration

    Swift

    public class KeyContainer : ModelObject
  • Representation of a time restriction for a badge. The badge will only be usable during this time.

    Declaration

    Swift

    public class TimeCondition : ModelObject
  • Representation of a location restriction for a badge. The badge will only be usable at this location.

    Declaration

    Swift

    public class LocationCondition : ModelObject
  • BeaconRegion

    Declaration

    Swift

    public class BeaconRegion : ModelObject
  • Encapsulates the beacon action

    Declaration

    Swift

    public class BeaconAction : ModelObject
  • Inbox message class. This class represents messages and polls sent from MicroStrategy Communicator (Usher Pro).

    Declaration

    Swift

    public class InboxMessage : ModelObject
  • Encapsulates the information of the QR code.

    Declaration

    Swift

    public class QRCode
  • The deeplink. Deeplink is used by other application to launch workflows managed by the UsherSDK. UsherSDK supports using deeplinks to configure server, install badges, and authorize usher login session in web page and mobile app.

    Declaration

    Swift

    public struct Deeplink
  • DeeplinkProcessingResult, returned from different deeplink processors.

    Declaration

    Swift

    public struct DeeplinkProcessingResult
  • The result of the Single Sign-On workflow. The workflow may be triggered by scanning a QR code or by deeplinking.

    Declaration

    Swift

    public struct SSOResult
  • A VPN connection request struct

    Declaration

    Swift

    public struct VPNRequest
  • The result of QRCode verification / processing

    Declaration

    Swift

    public struct VerifyQRResult
  • A user verification request struct

    Declaration

    Swift

    public struct UserVerificationRequest
  • Usher Error Class.

  • TLS Certificate

    Declaration

    Swift

    public class TLSCertificate : ModelObject
  • Typealias for tuple of a badge display property representing the name of the property and its value.

    Declaration

    Swift

    public typealias BadgeProperty = (name: String, value: Any)