MobileCredential

public protocol MobileCredential

A protocol that describes the registered mobile credential

  • id

    Gets the ID of the credential

    Declaration

    Swift

    var id: String { get }

    Return Value

    a string representation of the credential ID

  • Gets the facility ID of the credential

    Declaration

    Swift

    var facilityId: Int { get }

    Return Value

    An int representing the facility who issued the credential

  • Gets the name of the credential, some credentials can have no name (empty string) as configured by Command Centre site administrators

    Declaration

    Swift

    var facilityName: String { get }

    Return Value

    the credential name

  • The list of shared credentials to use with other Command Centre sites.

    Declaration

    Swift

    var sharedCredentials: [SharedCredential] { get }

    Return Value

    A shared credentials list identifying the shared Command Centre instances

  • Gets the date that the Mobile Credential was registered

    Declaration

    Swift

    var registeredDate: Date { get }

    Return Value

    The date that a Mobile Credential was registered

  • Gets if the credential is a single factor credential

    Declaration

    Swift

    var isSingleFactor: Bool { get }

  • Gets the credential two factor type which will be used to authenticate with

    Declaration

    Swift

    var secondFactorType: SecondFactorVerificationType? { get }

  • Gets the session URL. This URL is not supported for general use.

    Declaration

    Swift

    var sessionUrl: URL? { get }

    Return Value

    a session URL to query further details about a credential

  • Returns the internal status of the mobile credential. If the SDK has encountered any problems loading keys for this credential, those problems will be reported here.

    NOTE: Checking this property will cause the SDK to load keys and attempt to sign data with them. which may be an expensive operation. As such you should try not to read the status unless you absolutely need to.

    Declaration

    Swift

    var status: MobileCredentialStatus { get }

  • Gets if the credential has been revoked, which happens when the credential is deleted by an operator from the Command Centre server.

    Declaration

    Swift

    var isRevoked: Bool { get }

    Return Value

    True if this credential has been marked as revoked