AWFAerisAccount

Objective-C

@interface AWFAerisAccount : NSObject

Swift

class AWFAerisAccount : NSObject

An AWFAerisAccount object contains the access information associated with an API account.

  • The API key associated with the user account.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull apiKey;

    Swift

    var apiKey: String { get }

  • The secret key associated with the user account and application.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull secretKey;

    Swift

    var secretKey: String { get }

  • Account access permissions for Aeris API

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) AWFApiPermissions *apiPermissions;

    Swift

    var apiPermissions: AWFApiPermissions? { get }

  • Account access permissions for Aeris Maps

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) AWFMapPermissions *mapPermissions;

    Swift

    var mapPermissions: AWFMapPermissions? { get }

  • Initializes and returns an AWFAerisAccount instance with the specified API access key and secret. This account will be used for all requests to the Aeris API.

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithApiKey:(nonnull NSString *)apiKey
            secret:(nonnull NSString *)secretKey
        completion:
            (nullable AWFAerisAccountPermissionsCompletionBlock)completionBlock;

    Swift

    init(apiKey: String, secret secretKey: String, completion completionBlock: AWFAerisAccountPermissionsCompletionBlock? = nil)

    Parameters

    apiKey

    The access key for the account
    secretKey

    The account secret for the account
    completionBlock

    An optional block that is called when the account has been initialized and permissions have loaded

    Return Value

    The account instance initialized with the API key and secret