Inherits from NSObject
Conforms to NSCoding
NSCopying
Declared in VKAccessToken.h

Overview

Current class works with user access token and stores information about it:

Tasks

Properties

Initialization methods

Overridden methods

Public methods

Properties

creationTime

Access token creation time

@property (nonatomic, assign, readonly) NSTimeInterval creationTime

Declared In

VKAccessToken.h

isExpired

Is current access token expired?

@property (nonatomic, readonly) BOOL isExpired

Discussion

Current token is not expired if:

  • Token expiration time is greater then zero and greater then current time (timestamp)
  • Token expiration time equals zero and list of permissions contains “offline” permission

Declared In

VKAccessToken.h

isValid

Is current access token valid?

@property (nonatomic, readonly) BOOL isValid

Discussion

Returns YES if current access token is not nil and its not expired.

Declared In

VKAccessToken.h

liveTime

Access token life time.

@property (nonatomic, assign, readonly) NSTimeInterval liveTime

Declared In

VKAccessToken.h

permissions

Array of permissions which were granted to current application

@property (nonatomic, copy, readonly) NSArray *permissions

Declared In

VKAccessToken.h

token

Token (access token)

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

Declared In

VKAccessToken.h

userID

Unique user identifier

@property (nonatomic, assign, readonly) NSUInteger userID

Declared In

VKAccessToken.h

Instance Methods

description

Access token description.

- (NSString *)description

Return Value

String representation.

Declared In

VKAccessToken.h

hasPermission:

Method checks if list of permissions contains a permission.

- (BOOL)hasPermission:(NSString *)permission

Parameters

permission

permissions name (wall, offline, friends etc)

Return Value

YES - if list of permissions contains current permission, otherwise NO is returned.

Declared In

VKAccessToken.h

initWithUserID:accessToken:

Initialization method

- (instancetype)initWithUserID:(NSUInteger)userID accessToken:(NSString *)token

Parameters

userID

unique user identifier

token

access token

Return Value

instance of VKAccessToken class

Discussion

List of permissions defaults to an empty list (@[]). liveTime defaults to 0 (zero).

Declared In

VKAccessToken.h

initWithUserID:accessToken:liveTime:

Initialization method

- (instancetype)initWithUserID:(NSUInteger)userID accessToken:(NSString *)token liveTime:(NSTimeInterval)liveTime

Parameters

userID

unique user identifier

token

access token

liveTime

access token life time

Return Value

instance of VKAccessToken class

Discussion

List of permissions defaults to an empty list (@[]).

Declared In

VKAccessToken.h

initWithUserID:accessToken:liveTime:permissions:

Designated initialization method

- (instancetype)initWithUserID:(NSUInteger)userID accessToken:(NSString *)token liveTime:(NSTimeInterval)liveTime permissions:(NSArray *)permissions

Parameters

userID

unique user identifier

token

access token

liveTime

access token life time

permissions

list of all granted permissions

Return Value

instance of VKAccessToken class

Declared In

VKAccessToken.h

isEqual:

Checks if two access tokens are equal.

- (BOOL)isEqual:(VKAccessToken *)token

Parameters

token

another access token

Return Value

YES - if two access tokens are equal (tokens are equal if and only if their corresponding tokens, list of permissions and userIDs are equal), otherwise NO is returned.

Declared In

VKAccessToken.h