SPiDTokenRequest Class Reference
| Inherits from | SPiDRequest : NSObject |
| Declared in | SPiDTokenRequest.h SPiDTokenRequest.m |
Tasks
Public Methods
-
+ clientTokenRequestWithCompletionHandler:Creates a client token request
-
+ userTokenRequestWithCode:completionHandler:Creates a user token request with authorization code
-
+ userTokenRequestWithUsername:password:completionHandler:Creates a user token request with user credentials
-
+ userTokenRequestWithFacebookAppID:facebookToken:expirationDate:completionHandler:Creates a JWT facebook token request
-
+ refreshTokenRequestWithCompletionHandler:Creates a token refresh token request with the current access token
Private Methods
-
+ facebookJwtStringWithAppId:facebookToken:expirationDate:Generates a facebook JWT token as a encoded string
-
+ refreshTokenPostDataWithAccessToken:Generates post data for a token refresh
-
+ userTokenPostDataWithJwt:Generates post data for a user token request using JWT
-
+ userTokenPostDataWithUsername:password:Generates post data for a user token request using user credentials
-
+ userTokenPostDataWithCode:Generates post data for a access token request using authorization code
-
+ clientTokenPostDataGenerates post data for a client token request
-
– initPostTokenRequestWithPath:body:completionHandler:Initializes a token request
-
– connectionDidFinishLoading:NSURLConnectionDelegate method
-
– connection:didFailWithError:NSURLConnectionDelegate method
Class Methods
clientTokenPostData
Generates post data for a client token request
+ (NSDictionary *)clientTokenPostDataReturn Value
A dictionary containing the post data
Declared In
SPiDTokenRequest.mclientTokenRequestWithCompletionHandler:
Creates a client token request
+ (SPiDTokenRequest *)clientTokenRequestWithCompletionHandler:(void ( ^ ) ( NSError *error ))completionHandlerParameters
- completionHandler
Called on token request completion or error
Return Value
The token request or nil if JWT could not be created
Discussion
@param completionHandler
Declared In
SPiDTokenRequest.hfacebookJwtStringWithAppId:facebookToken:expirationDate:
Generates a facebook JWT token as a encoded string
+ (NSString *)facebookJwtStringWithAppId:(NSString *)appId facebookToken:(NSString *)facebookToken expirationDate:(NSDate *)expirationDateParameters
- appId
Facebook appID
- facebookToken
Facebook access token
- expirationDate
Expiration date for the facebook token
Return Value
JWT as a encoded string
Declared In
SPiDTokenRequest.mrefreshTokenPostDataWithAccessToken:
Generates post data for a token refresh
+ (NSDictionary *)refreshTokenPostDataWithAccessToken:(SPiDAccessToken *)accessTokenParameters
- accessToken
SPiDAccessTokento be refreshed
Return Value
Dictionary containing the post data
Declared In
SPiDTokenRequest.mrefreshTokenRequestWithCompletionHandler:
Creates a token refresh token request with the current access token
+ (SPiDTokenRequest *)refreshTokenRequestWithCompletionHandler:(void ( ^ ) ( NSError *))completionHandlerParameters
- completionHandler
Called on token request completion or error
Return Value
The token request or nil if refresh token is missing
Declared In
SPiDTokenRequest.huserTokenPostDataWithCode:
Generates post data for a access token request using authorization code
+ (NSDictionary *)userTokenPostDataWithCode:(NSString *)codeParameters
- code
Authorization code
Return Value
Dictionary containing the post data
Declared In
SPiDTokenRequest.muserTokenPostDataWithJwt:
Generates post data for a user token request using JWT
+ (NSDictionary *)userTokenPostDataWithJwt:(NSString *)jwtStringParameters
- jwtString
JWT as a encoded string
Return Value
Dictionary containing the post data
Declared In
SPiDTokenRequest.muserTokenPostDataWithUsername:password:
Generates post data for a user token request using user credentials
+ (NSDictionary *)userTokenPostDataWithUsername:(NSString *)username password:(NSString *)passwordParameters
- username
The username
- password
The password
Return Value
Dictionary containing the post data
Declared In
SPiDTokenRequest.muserTokenRequestWithCode:completionHandler:
Creates a user token request with authorization code
+ (SPiDTokenRequest *)userTokenRequestWithCode:(NSString *)code completionHandler:(void ( ^ ) ( NSError *))completionHandlerParameters
- code
The authorization code
- completionHandler
Called on token request completion or error
Return Value
The token request or nil if JWT could not be created
Declared In
SPiDTokenRequest.huserTokenRequestWithFacebookAppID:facebookToken:expirationDate:completionHandler:
Creates a JWT facebook token request
+ (SPiDTokenRequest *)userTokenRequestWithFacebookAppID:(NSString *)appId facebookToken:(NSString *)facebookToken expirationDate:(NSDate *)expirationDate completionHandler:(void ( ^ ) ( NSError *))completionHandlerParameters
- appId
Facebook appID
- facebookToken
Facebook access token
- expirationDate
Expiration date for the facebook token
- completionHandler
Called on token request completion or error
Return Value
The token request or nil if JWT could not be created
Declared In
SPiDTokenRequest.huserTokenRequestWithUsername:password:completionHandler:
Creates a user token request with user credentials
+ (SPiDTokenRequest *)userTokenRequestWithUsername:(NSString *)username password:(NSString *)password completionHandler:(void ( ^ ) ( NSError *error ))completionHandlerParameters
- username
The username
- password
The password
- completionHandler
Called on token request completion or error
Return Value
The token request or nil if JWT could not be created
Declared In
SPiDTokenRequest.hInstance Methods
connection:didFailWithError:
NSURLConnectionDelegate method
- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)errorParameters
- connection
The connection sending the message.
- error
An error object containing details of why the connection failed to load the request successfully.
Discussion
Sent when a connection fails to load its request successfully.
Declared In
SPiDTokenRequest.mconnectionDidFinishLoading:
NSURLConnectionDelegate method
- (void)connectionDidFinishLoading:(NSURLConnection *)connectionParameters
- connection
The connection sending the message.
Discussion
Sent when a connection has finished loading successfully.
Declared In
SPiDTokenRequest.minitPostTokenRequestWithPath:body:completionHandler:
Initializes a token request
- (id)initPostTokenRequestWithPath:(NSString *)requestPath body:(NSDictionary *)body completionHandler:(void ( ^ ) ( NSError *error ))completionHandlerParameters
- requestPath
Path to token endpoint
- body
Post body
- completionHandler
Called on request completion or error
Return Value
SPiDTokenRequest
Declared In
SPiDTokenRequest.m