SPiDAccessToken Class Reference

Inherits from	NSObject
Conforms to	NSCoding
Declared in	SPiDAccessToken.h SPiDAccessToken.m

Overview

Contains a access token that can be saved to the keychain

Tasks

Properties

userID
User ID for the current client
property
accessToken
The OAuth 2.0 access token
property
expiresAt
Expiry date for the access token
property
refreshToken
Refresh token used for refreshing the access token
property

Public methods

– initWithUserID:accessToken:expiresAt:refreshToken:
Initializes the AccessToken from the parameters
– initWithDictionary:
Initializes the AccessToken from a dictionary
– initWithCoder:
Decodes the access token
– encodeWithCoder:
Encodes the access token
– stringFromObject:
– hasExpired
Checks if the access token has expired
– isClientToken
Checks if the access token is a client token

Properties

accessToken

The OAuth 2.0 access token

@property (strong, nonatomic) NSString *accessToken

Declared In

SPiDAccessToken.h

expiresAt

Expiry date for the access token

@property (strong, nonatomic) NSDate *expiresAt

Declared In

SPiDAccessToken.h

refreshToken

Refresh token used for refreshing the access token

@property (strong, nonatomic) NSString *refreshToken

Declared In

SPiDAccessToken.h

userID

User ID for the current client

@property (strong, nonatomic) NSString *userID

Declared In

SPiDAccessToken.h

Instance Methods

encodeWithCoder:

Encodes the access token

- (void)encodeWithCoder:(NSCoder *)coder

Parameters

coder: Encoder to use

Declared In

SPiDAccessToken.h

hasExpired

Checks if the access token has expired

- (BOOL)hasExpired

Discussion

@Return Returns YES if access token has expired

Declared In

SPiDAccessToken.h

initWithCoder:

Decodes the access token

- (id)initWithCoder:(NSCoder *)decoder

Parameters

decoder: Decoder to use

Return Value

SPiDAccessToken

Declared In

SPiDAccessToken.h

initWithDictionary:

Initializes the AccessToken from a dictionary

- (id)initWithDictionary:(NSDictionary *)dictionary

Parameters

dictionary: Received data from SPiD

Return Value

SPiDAccessToken

Declared In

SPiDAccessToken.h

initWithUserID:accessToken:expiresAt:refreshToken:

Initializes the AccessToken from the parameters

- (id)initWithUserID:(NSString *)userID accessToken:(NSString *)accessToken expiresAt:(NSDate *)expiresAt refreshToken:(NSString *)refreshToken

Parameters

userID: Current user ID

accessToken: Access token

expiresAt: Access token expires at date

refreshToken: Refresh token

Return Value

SPiDAccessToken

Declared In

SPiDAccessToken.h

isClientToken

Checks if the access token is a client token

- (BOOL)isClientToken

Discussion

@Return Returns YES if the access token is a client token

Declared In

SPiDAccessToken.h

stringFromObject:

- (NSString *)stringFromObject:(id)obj