VLDUser
VLDUser stores the Validic User ID, Organization ID and Access Token of the User.
-
The user’s Validic ID
Declaration
Objective-C
@property (nonatomic, copy, readonly) NSString *validicUserID;
Swift
var validicUserID: String! { get }
-
The user’s Organization ID
Declaration
Objective-C
@property (nonatomic, copy, readonly) NSString *organizationID;
Swift
var organizationID: String! { get }
-
The user’s Access Token
Declaration
Objective-C
@property (nonatomic, copy, readonly) NSString *accessToken;
Swift
var accessToken: String! { get }
-
The user’s Marketplace Token
Declaration
Objective-C
@property (nonatomic, copy, readonly) NSString *marketplaceToken;
Swift
var marketplaceToken: String! { get }
-
Returns a default VLDUser that can be used to perform certain actions, but does not have the ability to submit records to the server.
Declaration
Objective-C
+ (instancetype)defaultUser;
Swift
class func `default`() -> Self!
-
Initializes VLDUser with a Validic User ID, Organization ID and User Access Token.
Declaration
Objective-C
- (instancetype)initWithValidicUserID:(NSString *)validicUserID organizationID:(NSString *)organizationID accessToken:(NSString *)accessToken;
Swift
init!(validicUserID: String!, organizationID: String!, accessToken: String!)
Parameters
validicUserID
the user ID.
organizationID
the organization ID.
accessToken
the user access token.
-
Initializes VLDUser with a Validic User ID, Organization ID, User Access Token, and Marketplace Token
Declaration
Objective-C
- (instancetype)initWithValidicUserID:(NSString *)validicUserID organizationID:(NSString *)organizationID accessToken:(NSString *)accessToken marketplaceToken:(NSString *)marketplaceToken;
Swift
convenience init!(validicUserID: String!, organizationID: String!, accessToken: String!, marketplaceToken: String!)
Parameters
validicUserID
the user ID.
organizationID
the organization ID.
accessToken
the user access token.
marketplaceToken
the user marketplace token
-
Method to check if the instance of VLDUser is the default user. The default user can only perform certain actions and cannot submit records to the server.
Declaration
Objective-C
- (BOOL)isDefaultUser;
Swift
func isDefaultUser() -> Bool
Return Value
YES if user was created with
[VLDUser defaultUser]
-
Method to check if the instance of VLDUser is valid, i.e. validicUserID, organizationID, and accessToken are all non-nil and non-empty. If this returns
false
, passing that instance to[VLDSession startSessionWithUser:]
will cause an exception to be thrown. If VLDSession loads a stored user that fails this check, the session must be ended with-endSession
.Declaration
Objective-C
- (BOOL)isValid;
Swift
func isValid() -> Bool
Return Value
YES if none of the required properties are nil or empty