JSONStore Class Reference
| Inherits from | NSObject |
| Declared in | JSONStore.h |
Tasks
-
_accessorsproperty -
_analyticsproperty -
_transactionActiveproperty -
+ sharedInstance -
– openCollections:withOptions:error: -
– openCollections:withOptions:error:completionHandler: -
– getCollectionWithName: -
– closeAllCollectionsAndReturnError: -
– destroyWithUsername:error: -
– destroyDataAndReturnError: -
– changeCurrentPassword:withNewPassword:forUsername:error: -
– fileInfoAndReturnError: -
– startTransactionAndReturnError: -
– commitTransactionAndReturnError: -
– rollbackTransactionAndReturnError:
Properties
_accessors
Private. Dictionary that holds JSONStoreCollection objects.
@property (nonatomic, strong) NSMutableDictionary *_accessorsAvailability
IBM Worklight V6.2.0
Declared In
JSONStore.hInstance Methods
changeCurrentPassword:withNewPassword:forUsername:error:
Changes the password that is associated with the security artifacts that are used to provide data encryption.
- (BOOL)changeCurrentPassword:(NSString *)oldPassword withNewPassword:(NSString *)newPassword forUsername:(NSString *)username error:(NSError **)errorParameters
- oldPassword
Old password
- newPassword
New password
- username
Username
- error
Error
Return Value
Boolean that indicates the operation failed (false) or succeeded (true)
Availability
IBM Worklight V6.2.0
Declared In
JSONStore.hcloseAllCollectionsAndReturnError:
Locks access to all the collections until openCollections:withOptions:error: is called.
- (BOOL)closeAllCollectionsAndReturnError:(NSError **)errorParameters
- error
Error
Return Value
Boolean that indicates the operation failed (false) or succeeded (true)
Availability
IBM Worklight V6.2.0
Declared In
JSONStore.hcommitTransactionAndReturnError:
Commits a transaction.
- (BOOL)commitTransactionAndReturnError:(NSError **)errorParameters
- error
Error
Return Value
Boolean that indicates the operation failed (false) or succeeded (true)
Availability
IBM Worklight V6.2.0
Declared In
JSONStore.hdestroyDataAndReturnError:
Permanently deletes all data for all users, clears security artifacts, and removes accessors.
- (BOOL)destroyDataAndReturnError:(NSError **)errorParameters
- error
Error
Return Value
Boolean that indicates the operation failed (false) or succeeded (true)
Availability
IBM Worklight V6.2.0
Declared In
JSONStore.hdestroyWithUsername:error:
Permanently deletes all data for a specific user, clears security artifacts, and removes accessors.
- (BOOL)destroyWithUsername:(NSString *)username error:(NSError **)errorParameters
- username
Username for the store to remove
- error
Error
Return Value
Boolean that indicates the operation failed (false) or succeeded (true)
Availability
IBM Worklight V6.3.0
Declared In
JSONStore.hfileInfoAndReturnError:
Returns information about the file that is used to persist data in the store.
- (NSArray *)fileInfoAndReturnError:(NSError **)errorParameters
- error
Error
Return Value
NSDictionary with information about the store. Returns the following key value pairs: name - name of the store, size - the total size, in bytes, of the store, and isEncrypted - boolean that is true when encrypted and false otherwise
Availability
IBM Worklight V6.2.0
Declared In
JSONStore.hgetCollectionWithName:
Provides an accessor to the collection if the collection exists. This depends on openCollections:withOptions:error: being called first, with the collection requested.
- (JSONStoreCollection *)getCollectionWithName:(NSString *)collectionNameParameters
- collectionName
Name of the opened collection
Return Value
Accessor to a single collection
Availability
IBM Worklight V6.2.0
Declared In
JSONStore.hopenCollections:withOptions:error:
Provides access to the collections inside the store, and creates them if they do not already exist.
- (BOOL)openCollections:(NSArray *)collections withOptions:(JSONStoreOpenOptions *)options error:(NSError **)errorReturn Value
Boolean that indicates the operation failed (false) or succeeded (true)
Availability
IBM Worklight V6.2.0
Declared In
JSONStore.hopenCollections:withOptions:error:completionHandler:
Provides access to the collections inside the store, and creates them if they do not already exist. Accepts a completion handler to update the status of the sync.
- (BOOL)openCollections:(NSArray *)collections withOptions:(JSONStoreOpenOptions *)options error:(NSError **)error completionHandler:(void ( ^ ) ( bool success , NSString *msg ))completionHandlerParameters
- collections
NSArray of JSONStoreCollection instances
- options
Options
- error
Error
- completionHandler
completionHandler
Return Value
Boolean that indicates the operation failed (false) or succeeded (true)
Availability
IBM Worklight V8.0.0
Declared In
JSONStore.h