VPNUAuthorizer
This class provides an interface for performing various authorization-related routines.
Discussion
Use this class to authorize with an existing KeepSolid account or create a new one. After initializing an instance of this class with an instance of VPNUTransport and performing authorization, be sure to pass the same instance of VPNUTransport to other classes which depend on it. Otherwise you will not be able to use all features of SDK.
Extends: NSObject
Declared in: VPNUAuthorizer.h
Class Methods
authorizerWithTransport:
+ (instancetype)authorizerWithTransport:(VPNUTransport *)transport;
Creates and returns a newly allocated authorizer object with the specified transport object.
Parameters
- transport
- The transport object for internal usage.
Return value
An initialized authorizer object or nil if the object couldn't be created.
Discussion
This method is a convenience constructor.
Instance Methods
authorizeWithLogin:andPassword:error:
- (VPNUAccountUserInfo *)authorizeWithLogin:(NSString *)login andPassword:(NSString *)password error:(NSError **)error;
Performs authorization.
Parameters
- login
- User's login. Cannot be nil.
- password
- User's password. Cannot be nil.
- error
- If request generates an error, a new error object is created and returned as an object pointed to by this parameter. Can be nil. Possible error responses: 302, 303, 311, 313(999), 318, 323, 361, 502
Return value
An object which represents the user's account information if no error has occured, nil otherwise.
Discussion
This method tries to authorize a user with specified login and password synchronously and waits for the response. It blocks a calling thread. This method shouldn't be called from main thread.
See also
initWithTransport:
- (instancetype)initWithTransport:(VPNUTransport *)transport NS_DESIGNATED_INITIALIZER;
Initializes and returns a newly allocated authorizer object with the specified transport object.
Parameters
- transport
- The transport object for internal usage.
Return value
An initialized authorizer object or nil if the object couldn't be created.
registerWithLogin:andPassword:marketingEmails:error:
- (VPNUAccountUserInfo *)registerWithLogin:(NSString *)login andPassword:(NSString *)password marketingEmails:(BOOL)doNotReceiveMarketingEmails error:(NSError **)error;
Registers a new user.
Parameters
- login
- User's login. Cannot be nil.
- password
- User's password. Cannot be nil.
- error
- If request generates an error, a new error object is created and returned as an object pointed to by this parameter. Can be nil. Possible error responses: 310, 312, 500, 502, 504
Return value
An object which represents the user's account information if no error has occured, nil otherwise.
Discussion
This method tries to register a new user with specified login and password synchronously and waits for the response. It blocks a calling thread. If registration is successful, it automatically logs in the newly created user. This method shouldn't be called from main thread.
See also
resendConfirmationEmailForLogin:error:
- (BOOL)resendConfirmationEmailForLogin:(NSString *)login error:(NSError **)error;
Asks the server to send confirmation email for specified login.
Parameters
- login
- User's login. Cannot be nil.
- error
- If request generates an error, a new error object is created and returned as an object pointed to by this parameter. Can be nil.
Return value
YES if no error has occured, NO otherwise.
Discussion
This method notifies the server that it needs to resend the confirmation letter to email associated with specified login. This method shouldn't be called from main thread.
signOutWithError:
- (BOOL)signOutWithError:(NSError **)error;
Signs out the already authorized user.
Parameters
- error
- If request generates an error, a new error object is created and returned as an object pointed to by this parameter. Can be nil. Possible error responses: 502, 503
Return value
YES if no error has occured, NO otherwise.
Discussion
This method clears current session, signals server about sign-out event and waits for the response. It blocks a calling thread. This method shouldn't be called from main thread.
See also