APService Class Reference
Inherits from | NSObject |
Declared in | APService.h APService.m |
Tasks
-
+ sharedInstance
-
– setHostName:contextRoot:customHeaderFields:
-
– setHostName:contextRoot:customHeaderFields:portNumber:
-
– setAppID:appVersion:hostName:contextRoot:customHeaderFields:portNumber:
-
isResetAppData
property -
deviceUDID
property -
deviceToken
property -
appVersion
property -
appID
property -
timeoutForRequest
property -
hostName
property -
contextRoot
property -
isUseSSL
property -
portNumber
property -
headers
property -
tokenID
property -
authInfo
property -
transactionID
property -
numberOfLoggingMaximum
property -
– setLoglevelAt:
-
– logError:
-
– logMonitor:
-
isUsingPushMessage
property -
– loginByUsername:password:onCompletion:onError:
-
– logoutOnCompletion:onError:
-
– deviceRegistration:onCompletion:onError:
Properties
appVersion
@abstract @property appVersion
@property (nonatomic, copy) NSString *appVersion
Discussion
@abstract @property appVersion
@discussion
Declared In
APService.h
authInfo
Object that holds information about login user and the groups and roles the user belong to. @property authInfo
@property (nonatomic, strong, readonly) APAuthInfo *authInfo
Declared In
APService.h
contextRoot
ContextRoot Name @property contextRoot
@property (nonatomic, copy) NSString *contextRoot
Declared In
APService.h
deviceToken
Gather form APNS. @property deviceToken
@property (nonatomic, copy) NSString *deviceToken
Declared In
APService.h
deviceUDID
Device UDID object @property device UDID
@property (nonatomic, copy, readonly) NSString *deviceUDID
Declared In
APService.h
headers
Headers @property headers
@property (nonatomic, copy) NSDictionary *headers
Declared In
APService.h
hostName
Host name @property host
@property (nonatomic, copy) NSString *hostName
Declared In
APService.h
isResetAppData
Reset database in server side @property isResetAppData
@property (nonatomic, assign) BOOL isResetAppData
Declared In
APService.h
isUseSSL
Define to indentify application user SSL or not. @property isUseSSL
@property (nonatomic) BOOL isUseSSL
Declared In
APService.h
isUsingPushMessage
@abstract
@property (nonatomic, assign) BOOL isUsingPushMessage
Discussion
@abstract
@discussion Authentication with 2 options: isUsingPushMessage is YES and NO. If YES: User developer must be implement deviceRegistration API or authentication will response error If NO: User developer doesn’t need implement deviceRegistration API. Response is NCResponse
Declared In
APService.h
numberOfLoggingMaximum
Define a number of logging in database. @property numberOfLogginMaximum
@property (nonatomic, assign) CGFloat numberOfLoggingMaximum
Declared In
APService.h
portNumber
Port. @property portNumber
@property (nonatomic) NSInteger portNumber
Declared In
APService.h
timeoutForRequest
Initializes a time out @property timeOut
@property (nonatomic) CGFloat timeoutForRequest
Declared In
APService.h
Instance Methods
deviceRegistration:onCompletion:onError:
Register DeviceID
- (void)deviceRegistration:(NSString *)deviceToken onCompletion:(APResponseBlock)completionBlock onError:(APErrorBlock)errorBlock
Declared In
APService.h
loginByUsername:password:onCompletion:onError:
Login
- (void)loginByUsername:(NSString *)username password:(NSString *)password onCompletion:(APAuthInfoBlock)completionBlock onError:(APErrorBlock)errorBlock
Declared In
APService.h
logoutOnCompletion:onError:
Logout
- (void)logoutOnCompletion:(APResponseBlock)completionBlock onError:(APErrorBlock)errorBlock
Declared In
APService.h
setAppID:appVersion:hostName:contextRoot:customHeaderFields:portNumber:
Initializes host name, header, port, app ID
- (void)setAppID:(NSString *)appID appVersion:(NSString *)version hostName:(NSString *)host contextRoot:(NSString *)contextRoot customHeaderFields:(NSDictionary *)headers portNumber:(NSInteger)port
Declared In
APService.h
setHostName:contextRoot:customHeaderFields:
Initializes host name and header
- (void)setHostName:(NSString *)hostName contextRoot:(NSString *)contextRoot customHeaderFields:(NSDictionary *)headers
Declared In
APService.h