UsherAPIRequestConfiguration

public struct UsherAPIRequestConfiguration : APIRequestConfigurationType

extension UsherAPIRequestConfiguration: URLConvertible, URLRequestConvertible

An APIRequestConfigurationType that configures API requirements for the Usher Server either by providing an UsherAPITask at initialization or initializing with a server and device instance. This class will also automatically configure other properties required by the Usher Server such as access token, location, device and OS info, locale, timezone and time.

device
Usher device
Declaration
Swift

public var device: Device?
server
Usher Server
Declaration
Swift

public var server: Server? { get set }
host
Server host address string
Declaration
Swift

public var host: String?
path
URL path
Declaration
Swift

public var path: String
method
Http method
Declaration
Swift

public var method: Alamofire.HTTPMethod
customHeaders
Custom API header fields. By default, this class adds User-Agent, Authorization, Accept, Accept-Encoding and Content-Type fields
Declaration
Swift

public var customHeaders: [String : String]


                    
                    
                    multipartFormData

Multipart form data

Declaration

Swift

public var multipartFormData: Alamofire.MultipartFormData?


                    
                    
                    parameters

URL parameters.

Declaration

Swift

public var parameters: [(Alamofire.ParameterEncoding, [String : CustomStringConvertible])]

requiresAccessToken
Set to true if API call requires access token. Default is true
Declaration
Swift

public var requiresAccessToken: Bool
responseDeserializer
Custom response deserializer closure. See CustomResponseDeserializer
Declaration
Swift

public var responseDeserializer: CustomResponseDeserializer?
customErrorExtractor
Custom error extractor closure. See CustomErrorExtractor
Declaration
Swift

public var customErrorExtractor: CustomErrorExtractor?
apiVersion
Server API version. Leave default value to connect to the latest API version.
Declaration
Swift

public var apiVersion: Int
errorVersion
Server API error version.
Declaration
Swift

public var errorVersion: Int
init()
Initializer
Declaration
Swift

public init()


                    
                    
                    init(with:and:)

Initializer

Declaration

Swift

public init(with server: Server, and device: Device)

Parameters

`server`	Server
`device`	Device


                    
                    
                    registerAPNSToken(_:)

Undocumented

Declaration

Swift

mutating mutating func registerAPNSToken(_ token: String)


                    
                    
                    configForAccessResource(config:)

Undocumented

Declaration

Swift

mutating mutating func configForAccessResource(config: AccessResourceConfig)


                    
                    
                    recordGenericCodeScan(config:)

Undocumented

Declaration

Swift

mutating mutating func recordGenericCodeScan(config: GenericCodeScanConfig)


                    
                    
                    approveVPN(request:)

Undocumented

Declaration

Swift

mutating mutating func approveVPN(request: VPNRequest)


                    
                    
                    rejectVPN(request:)

Undocumented

Declaration

Swift

mutating mutating func rejectVPN(request: VPNRequest)


                    
                    
                    requestRecoveryCodeForEmail(_:orgId:)

Undocumented

Declaration

Swift

mutating mutating func requestRecoveryCodeForEmail(_ email: String, orgId: String?)


                    
                    
                    retrieveRecoveryCodeForEmail(_:)

Undocumented

Declaration

Swift

mutating mutating func retrieveRecoveryCodeForEmail(_ email: String)


                    
                    
                    recoverBadgeByRecoveryCode(_:)

Undocumented

Declaration

Swift

mutating mutating func recoverBadgeByRecoveryCode(_ code: String)


                    
                    
                    recoverBadgeByInvitationCode(_:)

Undocumented

Declaration

Swift

mutating mutating func recoverBadgeByInvitationCode(_ code: String)


                    
                    
                    getBadge(_:)

Undocumented

Declaration

Swift

mutating mutating func getBadge(_ id: String)


                    
                    
                    getOrganizationInfo(_:)

Undocumented

Declaration

Swift

mutating mutating func getOrganizationInfo(_ id: String)


                    
                    
                    connectorUniversalLogin(orgId:)

Undocumented

Declaration

Swift

mutating mutating func connectorUniversalLogin(orgId: String)


                    
                    
                    recoverBadgeByCredentials(orgId:username:password:)

Undocumented

Declaration

Swift

mutating func recoverBadgeByCredentials(orgId: String,
                                        username: String,
                                        password: String)


                    
                    
                    deleteBadgeFromDevice(_:deviceId:)

Undocumented

Declaration

Swift

mutating mutating func deleteBadgeFromDevice(_ badgeId: String, deviceId: String)


                    
                    
                    deleteBadge(_:)

Undocumented

Declaration

Swift

mutating mutating func deleteBadge(_ badgeId: String)


                    
                    
                    updateUserProfileImageForBadge(_:image:)

Undocumented

Declaration

Swift

mutating mutating func updateUserProfileImageForBadge(_ badgeId: String, image: Data)


                    
                    
                    fetchUserProfileImageForBadge(_:)

Undocumented

Declaration

Swift

mutating mutating func fetchUserProfileImageForBadge(_ badgeId: String)


                    
                    
                    fetchIconForBadge(_:_:)

Undocumented

Declaration

Swift

mutating mutating func fetchIconForBadge(_ badgeId: String, _ iconURL: String)


                    
                    
                    fetchBackgroundImageForBadge(_:_:)

Undocumented

Declaration

Swift

mutating mutating func fetchBackgroundImageForBadge(_ badgeId: String, _ imageURL: String)


                    
                    
                    recordUserAgreement(touAccepted:ppAccepted:badgeId:)

Undocumented

Declaration

Swift

mutating mutating func recordUserAgreement(touAccepted: Bool, ppAccepted: Bool, badgeId: String)


                    
                    
                    getBeaconsForOrganization(_:)

Undocumented

Declaration

Swift

mutating mutating func getBeaconsForOrganization(_ orgId: String)


                    
                    
                    triggerActionForBeaconRegion(regionId:badgeId:actionType:beacon:exit:)

Undocumented

Declaration

Swift

mutating func triggerActionForBeaconRegion(regionId: String,
                                           badgeId: String,
                                           actionType: String,
                                           beacon: CLBeacon?,
                                           exit: Bool)


                    
                    
                    requestClientCertificate(for:)

Undocumented

Declaration

Swift

mutating mutating func requestClientCertificate(for device: Device)


                    
                    
                    requestClientCertificateRenewalCode(for:)

Undocumented

Declaration

Swift

mutating mutating func requestClientCertificateRenewalCode(for device: Device)


                    
                    
                    renewClientCertificate(for:renewalCode:)

Undocumented

Declaration

Swift

mutating mutating func renewClientCertificate(for device: Device, renewalCode: String)


                    
                    
                    fetchSymmetricKey(badgeId:lastKeyId:lastSightKeyId:version:)

Undocumented

Declaration

Swift

mutating mutating func fetchSymmetricKey(badgeId: String, lastKeyId: String?, lastSightKeyId: String?, version: Int)


                    
                    
                    ackSharedSymmetricKey(badgeId:orgId:lastKeyId:version:)

Undocumented

Declaration

Swift

mutating mutating func ackSharedSymmetricKey(badgeId: String, orgId: String, lastKeyId: String, version: Int)


                    
                    
                    initPairing(params:)

Undocumented

Declaration

Swift

mutating mutating func initPairing(params: DesktopPairingParams)


                    
                    
                    initPairingLegacy(params:)

Undocumented

Declaration

Swift

mutating mutating func initPairingLegacy(params: DesktopPairingParams)


                    
                    
                    fetchPairingCredentials(params:)

Undocumented

Declaration

Swift

mutating mutating func fetchPairingCredentials(params: DesktopPairingCredentialFetchParams)


                    
                    
                    submitCredentialToUnlock(params:)

Undocumented

Declaration

Swift

mutating mutating func submitCredentialToUnlock(params: DesktopUnlockCredentialSubmitParams)


                    
                    
                    reportDesktopEvent(event:)

Undocumented

Declaration

Swift

mutating mutating func reportDesktopEvent(event: DesktopReportEvent)


                    
                    
                    syncDesktopConfig(info:)

Undocumented

Declaration

Swift

mutating mutating func syncDesktopConfig(info: DesktopPairingInfo)


                    
                    
                    getInboxItems(requestType:badgeIds:currentBadgeId:)

Undocumented

Declaration

Swift

mutating mutating func getInboxItems(requestType: InboxAPIRequestType, badgeIds: [String], currentBadgeId: String)


                    
                    
                    replyToInboxMessage(notificationId:replyIndex:badgeId:)

Undocumented

Declaration

Swift

mutating mutating func replyToInboxMessage(notificationId: String, replyIndex: Int, badgeId: String)


                    
                    
                    getKeysForBadge(_:)

Undocumented

Declaration

Swift

mutating mutating func getKeysForBadge(_ badgeId: String)


                    
                    
                    getFavoriteKeysForBadge(_:)

Undocumented

Declaration

Swift

mutating mutating func getFavoriteKeysForBadge(_ badgeId: String)


                    
                    
                    saveFavoriteKeysForBadge(_:keysJSON:)

Undocumented

Declaration

Swift

mutating mutating func saveFavoriteKeysForBadge(_ badgeId: String, keysJSON: String)


                    
                    
                    useKey(_:resourceId:groupKey:)

Undocumented

Declaration

Swift

mutating mutating func useKey(_ id: String, resourceId: String?, groupKey: Bool)


                    
                    
                    useKey(code:badgeId:)

Undocumented

Declaration

Swift

mutating mutating func useKey(code: String, badgeId: String)


                    
                    
                    request2FACodeForBadge(_:phoneNumber:)

Undocumented

Declaration

Swift

mutating mutating func request2FACodeForBadge(_ id: String, phoneNumber: String)


                    
                    
                    verify2FACodeForBadge(_:code:)

Undocumented

Declaration

Swift

mutating mutating func verify2FACodeForBadge(_ id: String, code: String)


                    
                    
                    verify2FACodeForBadgeDeletion(_:deviceId:code:)

Undocumented

Declaration

Swift

mutating mutating func verify2FACodeForBadgeDeletion(_ id: String, deviceId: String, code: String)


                    
                    
                    renewTokens(refreshToken:)

Undocumented

Declaration

Swift

mutating mutating func renewTokens(refreshToken: String)


                    
                    
                    replyToChat(request:)

Undocumented

Declaration

Swift

mutating mutating func replyToChat(request: ReplyToChatRequest)


                    
                    
                    reportLocation(_:badgeId:)

Undocumented

Declaration

Swift

mutating mutating func reportLocation(_ locations: [CLLocation], badgeId: String)

serverVersion()
Undocumented
Declaration
Swift

mutating mutating func serverVersion()
serverConfiguration()
Undocumented
Declaration
Swift

mutating mutating func serverConfiguration()

Conformance to URLConvertible and URLRequestConvertible

asURL()
Formats the api URL using the host and the API path.

Throws
throws AFError.invalidURL if a URL cannot be formatted.
Declaration
Swift

public func asURL() throws -> URL
Return Value

Returns a URL combining the server host string and the API path.
asURLRequest()
Formats a URLRequest from configuration. This method will take care of setting property values and parameters required by Usher Server such as access token, location, device and OS info, locale, timezone and time. This method will throw error if URLRequest cannot be configured.
Declaration
Swift

public func asURLRequest() throws -> URLRequest
Return Value

A URLRequest instance


                    
                    
                    verifyQR(config:)

Undocumented

Declaration

Swift

mutating mutating func verifyQR(config: VerifyQRConfig)


                    
                    
                    verifyUser(request:)

Undocumented

Declaration

Swift

mutating mutating func verifyUser(request: UserVerificationRequest)

UsherAPIRequestConfiguration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Parameters

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Conformance to URLConvertible and URLRequestConvertible

Declaration

Return Value

Declaration

Return Value

Declaration

Declaration