CMISSession Class Reference
Inherits from | NSObject |
Declared in | CMISSession.h |
Tasks
-
authenticated
property -
binding
property -
sessionParameters
property -
repositoryInfo
property -
objectConverter
property -
+ arrayOfRepositories:completionBlock:
-
+ connectWithSessionParameters:completionBlock:
-
– retrieveRootFolderWithCompletionBlock:
-
– retrieveFolderWithOperationContext:completionBlock:
-
– retrieveObject:completionBlock:
-
– retrieveObject:operationContext:completionBlock:
-
– retrieveObjectByPath:completionBlock:
-
– retrieveObjectByPath:operationContext:completionBlock:
-
– retrieveTypeDefinition:completionBlock:
-
– query:searchAllVersions:completionBlock:
-
– query:searchAllVersions:operationContext:completionBlock:
-
– queryObjectsWithTypeid:whereClause:searchAllVersions:operationContext:completionBlock:
-
– createFolder:inFolder:completionBlock:
-
– downloadContentOfCMISObject:toFile:completionBlock:progressBlock:
-
– downloadContentOfCMISObject:toFile:offset:length:completionBlock:progressBlock:
-
– downloadContentOfCMISObject:toOutputStream:completionBlock:progressBlock:
-
– downloadContentOfCMISObject:toOutputStream:offset:length:completionBlock:progressBlock:
-
– createDocumentFromFilePath:mimeType:properties:inFolder:completionBlock:progressBlock:
-
– createDocumentFromInputStream:mimeType:properties:inFolder:bytesExpected:completionBlock:progressBlock:
Class Methods
arrayOfRepositories:completionBlock:
completionBlock returns a list of repositories or nil if unsuccessful
+ (CMISRequest *)arrayOfRepositories:(CMISSessionParameters *)sessionParameters completionBlock:(void ( ^ ) ( NSArray *repositories , NSError *error ))completionBlock
Discussion
completionBlock returns a list of repositories or nil if unsuccessful
Declared In
CMISSession.h
connectWithSessionParameters:completionBlock:
completionBlock returns a CMIS session or nil if unsuccessful
+ (CMISRequest *)connectWithSessionParameters:(CMISSessionParameters *)sessionParameters completionBlock:(void ( ^ ) ( CMISSession *session , NSError *error ))completionBlock
Discussion
completionBlock returns a CMIS session or nil if unsuccessful
Declared In
CMISSession.h
Instance Methods
createDocumentFromFilePath:mimeType:properties:inFolder:completionBlock:progressBlock:
Creates a cmis document using the content from the file path. completionBlock returns object Id of newly created object or nil if unsuccessful
- (CMISRequest *)createDocumentFromFilePath:(NSString *)filePath mimeType:(NSString *)mimeType properties:(NSDictionary *)properties inFolder:(NSString *)folderObjectId completionBlock:(void ( ^ ) ( NSString *objectId , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Discussion
Creates a cmis document using the content from the file path. completionBlock returns object Id of newly created object or nil if unsuccessful
Declared In
CMISSession.h
createDocumentFromInputStream:mimeType:properties:inFolder:bytesExpected:completionBlock:progressBlock:
Creates a cmis document using the content from the given stream. completionBlock returns object Id of newly created object or nil if unsuccessful
- (CMISRequest *)createDocumentFromInputStream:(NSInputStream *)inputStream mimeType:(NSString *)mimeType properties:(NSDictionary *)properties inFolder:(NSString *)folderObjectId bytesExpected:(unsigned long long)bytesExpected completionBlock:(void ( ^ ) ( NSString *objectId , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Discussion
Creates a cmis document using the content from the given stream. completionBlock returns object Id of newly created object or nil if unsuccessful
Declared In
CMISSession.h
createFolder:inFolder:completionBlock:
Creates a folder in the provided folder. completionBlock returns the object Id of the newly created folder or nil if unsuccessful
- (CMISRequest *)createFolder:(NSDictionary *)properties inFolder:(NSString *)folderObjectId completionBlock:(void ( ^ ) ( NSString *objectId , NSError *error ))completionBlock
Discussion
Creates a folder in the provided folder. completionBlock returns the object Id of the newly created folder or nil if unsuccessful
Declared In
CMISSession.h
downloadContentOfCMISObject:toFile:completionBlock:progressBlock:
Downloads the content of object with the provided object id to the given path. completionBlock NSError will be nil if successful
- (CMISRequest *)downloadContentOfCMISObject:(NSString *)objectId toFile:(NSString *)filePath completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Discussion
Downloads the content of object with the provided object id to the given path. completionBlock NSError will be nil if successful
Declared In
CMISSession.h
downloadContentOfCMISObject:toFile:offset:length:completionBlock:progressBlock:
Downloads the content of object with the provided object id to the given path. completionBlock NSError will be nil if successful Provides options to resume download
- (CMISRequest *)downloadContentOfCMISObject:(NSString *)objectId toFile:(NSString *)filePath offset:(NSDecimalNumber *)offset length:(NSDecimalNumber *)length completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Discussion
Downloads the content of object with the provided object id to the given path. completionBlock NSError will be nil if successful Provides options to resume download
Declared In
CMISSession.h
downloadContentOfCMISObject:toOutputStream:completionBlock:progressBlock:
Downloads the content of object with the provided object id to the given stream. completionBlock NSError will be nil if successful
- (CMISRequest *)downloadContentOfCMISObject:(NSString *)objectId toOutputStream:(NSOutputStream *)outputStream completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Discussion
Downloads the content of object with the provided object id to the given stream. completionBlock NSError will be nil if successful
Declared In
CMISSession.h
downloadContentOfCMISObject:toOutputStream:offset:length:completionBlock:progressBlock:
Downloads the content of object with the provided object id to the given stream. completionBlock NSError will be nil if successful Provides options to resume download
- (CMISRequest *)downloadContentOfCMISObject:(NSString *)objectId toOutputStream:(NSOutputStream *)outputStream offset:(NSDecimalNumber *)offset length:(NSDecimalNumber *)length completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Discussion
Downloads the content of object with the provided object id to the given stream. completionBlock NSError will be nil if successful Provides options to resume download
Declared In
CMISSession.h
query:searchAllVersions:completionBlock:
Retrieves all objects matching the given cmis query. completionBlock returns the search results as a paged results object or nil if unsuccessful.
- (CMISRequest *)query:(NSString *)statement searchAllVersions:(BOOL)searchAllVersion completionBlock:(void ( ^ ) ( CMISPagedResult *pagedResult , NSError *error ))completionBlock
Discussion
Retrieves all objects matching the given cmis query. completionBlock returns the search results as a paged results object or nil if unsuccessful.
Declared In
CMISSession.h
query:searchAllVersions:operationContext:completionBlock:
Retrieves all objects matching the given cmis query, as CMISQueryResult objects. and using the parameters provided in the operation context. completionBlock returns the search results as a paged results object or nil if unsuccessful.
- (CMISRequest *)query:(NSString *)statement searchAllVersions:(BOOL)searchAllVersion operationContext:(CMISOperationContext *)operationContext completionBlock:(void ( ^ ) ( CMISPagedResult *pagedResult , NSError *error ))completionBlock
Discussion
Retrieves all objects matching the given cmis query, as CMISQueryResult objects. and using the parameters provided in the operation context. completionBlock returns the search results as a paged results object or nil if unsuccessful.
Declared In
CMISSession.h
queryObjectsWithTypeid:whereClause:searchAllVersions:operationContext:completionBlock:
Queries for a specific type of objects. Returns a paged result set, containing CMISObject instances. completionBlock returns the search results as a paged results object or nil if unsuccessful.
- (CMISRequest *)queryObjectsWithTypeid:(NSString *)typeId whereClause:(NSString *)whereClause searchAllVersions:(BOOL)searchAllVersion operationContext:(CMISOperationContext *)operationContext completionBlock:(void ( ^ ) ( CMISPagedResult *result , NSError *error ))completionBlock
Discussion
Queries for a specific type of objects. Returns a paged result set, containing CMISObject instances. completionBlock returns the search results as a paged results object or nil if unsuccessful.
Declared In
CMISSession.h
retrieveFolderWithOperationContext:completionBlock:
Retrieves the root folder for the repository using the provided operation context. completionBlock returns a folder of the repo or nil if unsuccessful
- (CMISRequest *)retrieveFolderWithOperationContext:(CMISOperationContext *)operationContext completionBlock:(void ( ^ ) ( CMISFolder *folder , NSError *error ))completionBlock
Discussion
Retrieves the root folder for the repository using the provided operation context. completionBlock returns a folder of the repo or nil if unsuccessful
Declared In
CMISSession.h
retrieveObject:completionBlock:
Retrieves the object with the given identifier. completionBlock returns the CMIS object or nil if unsuccessful
- (CMISRequest *)retrieveObject:(NSString *)objectId completionBlock:(void ( ^ ) ( CMISObject *object , NSError *error ))completionBlock
Discussion
Retrieves the object with the given identifier. completionBlock returns the CMIS object or nil if unsuccessful
Declared In
CMISSession.h
retrieveObject:operationContext:completionBlock:
Retrieves the object with the given identifier, using the provided operation context. completionBlock returns the CMIS object or nil if unsuccessful
- (CMISRequest *)retrieveObject:(NSString *)objectId operationContext:(CMISOperationContext *)operationContext completionBlock:(void ( ^ ) ( CMISObject *object , NSError *error ))completionBlock
Discussion
Retrieves the object with the given identifier, using the provided operation context. completionBlock returns the CMIS object or nil if unsuccessful
Declared In
CMISSession.h
retrieveObjectByPath:completionBlock:
Retrieves the object for the given path. completionBlock returns the CMIS object or nil if unsuccessful
- (CMISRequest *)retrieveObjectByPath:(NSString *)path completionBlock:(void ( ^ ) ( CMISObject *object , NSError *error ))completionBlock
Discussion
Retrieves the object for the given path. completionBlock returns the CMIS object or nil if unsuccessful
Declared In
CMISSession.h
retrieveObjectByPath:operationContext:completionBlock:
Retrieves the object for the given path, using the provided operation context. completionBlock returns the CMIS object or nil if unsuccessful
- (CMISRequest *)retrieveObjectByPath:(NSString *)path operationContext:(CMISOperationContext *)operationContext completionBlock:(void ( ^ ) ( CMISObject *object , NSError *error ))completionBlock
Discussion
Retrieves the object for the given path, using the provided operation context. completionBlock returns the CMIS object or nil if unsuccessful
Declared In
CMISSession.h
retrieveRootFolderWithCompletionBlock:
Retrieves the root folder for the repository. completionBlock returns the root folder of the repo or nil if unsuccessful
- (CMISRequest *)retrieveRootFolderWithCompletionBlock:(void ( ^ ) ( CMISFolder *folder , NSError *error ))completionBlock
Discussion
Retrieves the root folder for the repository. completionBlock returns the root folder of the repo or nil if unsuccessful
Declared In
CMISSession.h
retrieveTypeDefinition:completionBlock:
Retrieves the definition for the given type. completionBlock returns the CMIS type definition or nil if unsuccessful
- (CMISRequest *)retrieveTypeDefinition:(NSString *)typeId completionBlock:(void ( ^ ) ( CMISTypeDefinition *typeDefinition , NSError *error ))completionBlock
Discussion
Retrieves the definition for the given type. completionBlock returns the CMIS type definition or nil if unsuccessful
Declared In
CMISSession.h