EMCapTokenManager

Objective-C

@protocol EMCapTokenManager <NSObject, EMTokenManager>

Swift

protocol EMCapTokenManager : EMTokenManager

CAP Token Manager

  • Returns an existing token with the given name.

    Declaration

    Objective-C

    - (id<EMCapToken>)tokenWithName:(NSString *)name error:(NSError **)error;

    Swift

    func token(withName name: String!) throws -> any EMCapToken

    Parameters

    name

    The name of the token.

    error

    If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

    Return Value

    The token, nil if not found or if an error occurred.

  • Returns an existing token with the given name and fingerprint.

    Declaration

    Objective-C

    - (id<EMCapToken>)tokenWithName:(NSString *)name
              fingerprintCustomData:(NSData *)fingerprintCustomData
                              error:(NSError **)error;

    Swift

    func token(withName name: String!, fingerprintCustomData: Data!) throws -> any EMCapToken

    Parameters

    name

    The name of the token.

    fingerprintCustomData

    The fingerprint custom data.

    error

    If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

    Return Value

    The token, nil if not found or if an error occurred.

  • Returns an existing token with the given UTI (user token id).

    Since

    4.5

    Declaration

    Objective-C

    - (id<EMCapToken>)tokenWithUti:(long)uti error:(NSError **)error;

    Swift

    func token(withUti uti: Int) throws -> any EMCapToken

    Parameters

    uti

    The UTI of the token.

    error

    If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

    Return Value

    The token, nil if not found or if an error occurred.

  • Returns an existing token with the given UTI (user token id) and fingerprint.

    Since

    4.5

    Declaration

    Objective-C

    - (id<EMCapToken>)tokenWithUti:(long)uti
             fingerprintCustomData:(NSData *)fingerprintCustomData
                             error:(NSError **)error;

    Swift

    func token(withUti uti: Int, fingerprintCustomData: Data!) throws -> any EMCapToken

    Parameters

    uti

    The UTI of the token.

    fingerprintCustomData

    The fingerprint custom data.

    error

    If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

    Return Value

    The token, nil if not found or if an error occurred.

  • Starts the creation of a new token with the specified token name and the provisioning configuration. Before creating the token, integrator has to make sure there is no existing token with the same token name.

    Declaration

    Objective-C

    - (void)createTokenWithName:(NSString *)name
        provisioningConfiguration:(EMProvisioningConfiguration *)configuration
                completionHandler:
                    (void (^)(id<EMCapToken>, NSError *))completionHandler;

    Swift

    func createToken(withName name: String!, provisioningConfiguration configuration: EMProvisioningConfiguration!) async throws -> (any EMCapToken)?

    Parameters

    name

    The token name.

    configuration

    The provisioning configuration.

    completionHandler

    mandatory block to be invoked when error occurs or when token creation is completed.

  • Starts the creation of a new token with the specified token name, provisioning configuration, and device fingerprint policy. Before creating the token, integrator has to make sure there is no existing token with the same token name. This API does not support Mobile Provisioning Protocol version 5.

    Declaration

    Objective-C

    - (void)createTokenWithName:(NSString *)name
           provisioningConfiguration:(EMProvisioningConfiguration *)configuration
        deviceFingerprintTokenPolicy:
            (EMDeviceFingerprintTokenPolicy *)deviceFingerprintTokenPolicy
                   completionHandler:
                       (void (^)(id<EMCapToken>, NSError *))completionHandler;

    Swift

    func createToken(withName name: String!, provisioningConfiguration configuration: EMProvisioningConfiguration!, deviceFingerprintTokenPolicy: EMDeviceFingerprintTokenPolicy!) async throws -> (any EMCapToken)?

    Parameters

    name

    The token name.

    configuration

    The provisioning configuration.

    deviceFingerprintTokenPolicy

    device fingerprint token policy

    completionHandler

    mandatory block to be invoked when error occurs or when token creation is completed.

  • Starts the creation of a new token with the specified token name, provisioning configuration, and device fingerprint policy. Before creating the token, integrator has to make sure there is no existing token with the same token name. This API support Mobile Provisioning Protocol version 5 which will allows extensions to provide additional information set by the server, if any.

    Since

    5.0

    Declaration

    Objective-C

    - (void)createTokenWithName:(NSString *)name
           provisioningConfiguration:(EMProvisioningConfiguration *)configuration
        deviceFingerprintTokenPolicy:
            (EMDeviceFingerprintTokenPolicy *)deviceFingerprintTokenPolicy
           extendedCompletionHandler:(void (^)(id<EMCapToken>, NSDictionary *,
                                               NSError *))completionHandler;

    Swift

    func createToken(withName name: String!, provisioningConfiguration configuration: EMProvisioningConfiguration!, deviceFingerprintTokenPolicy: EMDeviceFingerprintTokenPolicy!) async throws -> ((any EMCapToken)?, [AnyHashable : Any]?)

    Parameters

    name

    The token name.

    configuration

    The provisioning configuration.

    deviceFingerprintTokenPolicy

    device fingerprint token policy

    completionHandler

    mandatory block to be invoked when error occurs or when token creation is completed. Specific for Mobile Provisioning Protocol version 5, this handler will contains extensions information for any string extension of “client.app.*”

  • To Creates a LowPlatformCoupling Token which is not affected by the changes in DeviceFingerprint. A LowPlatformCoupling Token only permits PIN mode. [token upgradeToMultiAuthMode:input error:error] call is not allowed.

    Since

    5.2.0

    Declaration

    Objective-C

    - (void)createLowPlatformCouplingToken:(NSString *)name
                 provisioningConfiguration:
                     (EMProvisioningConfiguration *)configuration
                 extendedCompletionHandler:(void (^)(id<EMCapToken>, NSDictionary *,
                                                     NSError *))completionHandler;

    Swift

    func createLowPlatformCouplingToken(_ name: String!, provisioningConfiguration configuration: EMProvisioningConfiguration!) async throws -> ((any EMCapToken)?, [AnyHashable : Any]?)

    Parameters

    name

    The token name.

    configuration

    The provisioning configuration.

    completionHandler

    mandatory block to be invoked when error occurs or when token creation is completed. Specific for Mobile Provisioning Protocol version 5, this handler will contains extensions information for any string extension of “client.app.*”