VSSBaseClient Class Reference

Inherits from NSObject
Declared in VSSBaseClient.h

Overview

Base class for the Virgil Services client.

Contains utility functionality to maintain all kinds of the requests to the services.

Other Methods

  token

String token which might be required by the service.

@property (nonatomic, strong, readonly) NSString *token

Declared In

VSSBaseClient.h

  serviceConfig

Service configuration object, which contains the information about the service URLs and/or service identifiers.

@property (nonatomic, strong, readonly) VSSServiceConfig *serviceConfig

Declared In

VSSBaseClient.h

Lifecycle

– initWithApplicationToken:serviceConfig:

Designated constructor. Creates instance of VSSClient particular class.

- (instancetype __nonnull)initWithApplicationToken:(NSString *__nonnull)token serviceConfig:(VSSServiceConfig *__nullable)serviceConfig

Parameters

token

NSString containing application token received from https://api.virgilsecurity.com

serviceConfig

Object containing the service configuration. When nil - the default Virgil Service configuration will be used.

Return Value

Instance of the Virgil client.

Declared In

VSSBaseClient.h

– initWithApplicationToken:

Convenient constructor. Creates instance of VSSClient particular class. Call to this method is a shortcut for the initWithApplicationToken:serviceConfig: when serviceConfig is nil.

- (instancetype __nonnull)initWithApplicationToken:(NSString *__nonnull)token

Parameters

token

NSString containing application token received from https://api.virgilsecurity.com

Return Value

Instance of the Virgil client.

Declared In

VSSBaseClient.h

Setup

– setupClientWithCompletionHandler:

Performs initial setup of the client.

- (void)setupClientWithCompletionHandler:(void ( ^ __nullable ) ( NSError *__nullable ))completionHandler

Parameters

completionHandler

Callback to call when setup is done.

Discussion

Parent implementation is just calls the completion handler on the background thread.

Declared In

VSSBaseClient.h

Utility

– send:

Adds given request to the execution queue and sends it to service.

- (void)send:(VSSRequest *__nonnull)request

Parameters

request

The particular request to be performed.

Declared In

VSSBaseClient.h