VPNUAccount
This class provides an interface for retrieving miscellaneous information about currently logged-in user.
Discussion
Before using this class you must authorize or register with the help of VPNUAuthorizer class. You must pass the same VPNUTransport instance to its constructor as you have passed to VPNUAuthorizer instance constructor.
Extends: NSObject
Declared in: VPNUAccount.h
Class Methods
accountWithTransport:
+ (instancetype)accountWithTransport:(VPNUTransport *)transport;
Creates and returns a newly allocated account object with the specified transport object.
Parameters
- transport
- The transport object for internal usage.
Return value
An initialized account object or nil if the object couldn't be created.
Discussion
This method is a convenience constructor.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
Instance Methods
devicesWithError:
- (NSArray<VPNUAccountDevice *> *)devicesWithError:(NSError **)error;
Retrieves a list of currently logged-in user's used devices.
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.
Return value
An array of VPNUAccountDevice objects for currently logged-in user.
Discussion
It blocks a calling thread.
Warning
This method shouldn't be called from main thread.
See also
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
initWithTransport:
- (instancetype)initWithTransport:(VPNUTransport *)transport NS_DESIGNATED_INITIALIZER;
Initializes and returns a newly allocated account object with the specified transport object.
Parameters
- transport
- The transport object for internal usage.
Return value
An initialized account object or nil if the object couldn't be created.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
statisticsForDevice:withError:
- (NSArray<VPNUAccountDeviceStatistics *> *) statisticsForDevice:(VPNUAccountDevice *)device withError:(NSError **)error;
Retrieves a list of currently logged-in user's statistics for provided device.
Parameters
- device
- A device object for which to retrieve statistics.
- 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
An array of VPNUAccountDeviceStatistics objects for currently logged-in user. Each object represents statistics for a specific date.
Discussion
It blocks a calling thread.
Warning
This method shouldn't be called from main thread.
See also
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
statusWithError:
- (VPNUAccountStatus *)statusWithError:(NSError **)error;
Retrieves the currently logged-in user's account status.
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.
Return value
Currently logged-in user's account status.
Discussion
It blocks a calling thread.
Warning
This method shouldn't be called from main thread.
See also
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
userInfoWithError:
- (VPNUAccountUserInfo *)userInfoWithError:(NSError **)error;
Retrieves the currently logged-in user's account information.
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.
Return value
Currently logged-in user's account information.
Discussion
It blocks a calling thread.
Warning
This method shouldn't be called from main thread.
See also
VPNUAccountUserInfo
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.