Classes

The following classes are available globally.

  • Helps building an access token payload.

    See more

    Declaration

    Objective-C

    @interface AccessTokenBuilder : NSObject

    Swift

    class AccessTokenBuilder : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface NotifyResult : NSObject

+ (NotifyResult *)createWithNotifyStatus:(NotifyStatus)notifyStatus notificationId:(NSString *)notificationId;

@property (nonatomic, readonly) NotifyStatus notifyStatus;
@property (nonatomic, readonly) NSString *notificationId;

@end

    Swift

    class NotifyResult : NSObject

  • Wraps results returned from the offset/limit enabled methods.

    See more

    Declaration

    Objective-C

    @interface PagedArray<T> : NSObject {
  NSArray<T> *pagedItems;
  NSString *pageOffset;
}

    Swift

    class PagedArray<T> : NSObject where T : AnyObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface PrepareTokenResult : NSObject
+ (PrepareTokenResult *)create:(TokenPayload *)tokenPayload policy:(Policy *)policy;

@property (nonatomic, readonly) TokenPayload *tokenPayload;
@property (nonatomic, readonly) Policy *policy;

@end

    Swift

    class PrepareTokenResult : NSObject

  • Represents a funding account in the Token system.

    The class provides async API

    See more

    Declaration

    Objective-C

    @interface TKAccount : NSObject

    Swift

    class TKAccount : NSObject

  • A bank account’s balance.

    See more

    Declaration

    Objective-C

    @interface TKBalance : NSObject

    Swift

    class TKBalance : NSObject

  • Represents a Member in the Token system. Each member has an active secret and public key pair that is used to perform authentication.

    The class provides async API

    See more

    Declaration

    Objective-C

    @interface TKMember : NSObject <TKRepresentable>

    Swift

    class TKMember : NSObject, TKRepresentable

  • Use this class to create a new member with createMember method or use an existing member with getMember.

    The class provides async API

    See more

    Declaration

    Objective-C

    @interface TokenClient : NSObject

    Swift

    class TokenClient : NSObject

  • A builder that is used to customize and create TokenIO and TokenIOSync instances that serve as the Token API entry points.

    See more

    Declaration

    Objective-C

    @interface TokenClientBuilder : NSObject

    Swift

    class TokenClientBuilder : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface TokenCluster : NSObject <NSCopying>
@property (nonatomic, readonly, strong) NSString *envUrl;
@property (nonatomic, readonly, strong) NSString *webAppUrl;

- (id)initWithEnvUrl:(NSString *)envUrl webAppUrl:(NSString *)webAppUrl;

+ (TokenCluster *)development;

+ (TokenCluster *)integration;

+ (TokenCluster *)integration2;

+ (TokenCluster *)localhost;

+ (TokenCluster *)sandbox;

+ (TokenCluster *)staging;

+ (TokenCluster *)performance;

+ (TokenCluster *)production;
@end

    Swift

    class TokenCluster : NSObject, NSCopying

  • Helper class that builds Transfer Tokens.

    See more

    Declaration

    Objective-C

    @interface TransferTokenBuilder : NSObject

    Swift

    class TransferTokenBuilder : NSObject

  • The browser for external authorization. Whenever external authorization is required, the browser will be invoked by TKAuthorizationEngine. To Use customized browsers:

    1. Defines subclass from TKBrowser
    2. Implements override methods.
    3. Sets customized TKBrowserFactory in TokenIO.
    See more

    Declaration

    Objective-C

    @interface TKBrowser : NSObject

    Swift

    class TKBrowser : NSObject

  • An abstract class that defines a set of methods that deal with crypto, key generation, method signing, etc. There are two abstract methods that need to be implemented in the derived classes signData and verifySignature:forData.

    See more

    Declaration

    Objective-C

    @interface TKCrypto : NSObject

    Swift

    class TKCrypto : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface TKTokenCryptoEngineFactory : NSObject<TKCryptoEngineFactory>

/**
 * Create TKTokenCryptoEngineFactory with customized key store.
 * @param storage the customized key store
 * @param useLocalAuthentication require local authentication to sign data. If you are using your
 * own key storage, Token crypto engine will ask for local authentication when you sign data
 * by default. Disabling this will skip the local authentication
 */
+ (id<TKCryptoEngineFactory>)factoryWithStore:(id<TKKeyStore>)storage
                       useLocalAuthentication:(BOOL)useLocalAuthentication;

@end

    Swift

    class TKTokenCryptoEngineFactory : NSObject, TKCryptoEngineFactory

  • Converts proto buffer messages to JSON. gRPC lib from Google doesn’t implement this yet. We want the code to match what Google does because we use this to compile a message content for signing.

    See implementation notes.

    See more

    Declaration

    Objective-C

    @interface TKJson : NSObject

    Swift

    class TKJson : NSObject

  • Set of utility methods.

    See more

    Declaration

    Objective-C

    @interface TKUtil : NSObject

    Swift

    class TKUtil : NSObject