CMISDocument Class Reference
Inherits from | CMISFileableObject : CMISObject : CMISObjectId : NSObject |
Conforms to | NSURLConnectionDataDelegate |
Declared in | CMISDocument.h |
Tasks
-
contentStreamId
property -
contentStreamFileName
property -
contentStreamMediaType
property -
contentStreamLength
property -
versionLabel
property -
latestVersion
property -
majorVersion
property -
latestMajorVersion
property -
versionSeriesId
property -
– retrieveAllVersionsWithCompletionBlock:
Retrieves a collection of all versions of this document. The completionBlock returns collection of all documents or nil if unsuccessful
-
– retrieveAllVersionsWithOperationContext:completionBlock:
Retrieves a collection of all versions of this document with paging options. The completionBlock returns collection of all documents or nil if unsuccessful
-
– retrieveObjectOfLatestVersionWithMajorVersion:completionBlock:
Retrieves the lastest version of this document. The completionBlock returns the CMIS document or nil if unsuccessful
-
– retrieveObjectOfLatestVersionWithMajorVersion:operationContext:completionBlock:
Retrieves the lastest version of this document with paging options. The completionBlock returns the CMIS document or nil if unsuccessful
-
– downloadContentToFile:completionBlock:progressBlock:
Downloads the content to a local file and returns the filepath. completionBlock will return NSError nil if successful
-
– downloadContentToOutputStream:completionBlock:progressBlock:
Downloads the content to an outputstream and returns the handle to the http request in order to allow cancellation. completionBlock will return NSError nil if successful
-
– changeContentToContentOfFile:mimeType:overwrite:completionBlock:progressBlock:
Changes the content of this document to the content of the given file.
-
– changeContentToContentOfInputStream:bytesExpected:fileName:mimeType:overwrite:completionBlock:progressBlock:
Changes the content of this document to the content of the given input stream.
-
– deleteContentWithCompletionBlock:
Deletes the content of this document. completionBlock will return NSError nil if successful
-
– deleteAllVersionsWithCompletionBlock:
Deletes the document from the document store. completionBlock return true if successful
Properties
Instance Methods
changeContentToContentOfFile:mimeType:overwrite:completionBlock:progressBlock:
Changes the content of this document to the content of the given file.
- (CMISRequest *)changeContentToContentOfFile:(NSString *)filePath mimeType:(NSString *)mimeType overwrite:(BOOL)overwrite completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Discussion
Changes the content of this document to the content of the given file.
Optional overwrite flag: If TRUE (default), then the Repository MUST replace the existing content stream for the object (if any) with the input contentStream. If FALSE, then the Repository MUST only set the input contentStream for the object if the object currently does not have a content-stream. completionBlock will return NSError nil if successful
Declared In
CMISDocument.h
changeContentToContentOfInputStream:bytesExpected:fileName:mimeType:overwrite:completionBlock:progressBlock:
Changes the content of this document to the content of the given input stream.
- (CMISRequest *)changeContentToContentOfInputStream:(NSInputStream *)inputStream bytesExpected:(unsigned long long)bytesExpected fileName:(NSString *)fileName mimeType:(NSString *)mimeType overwrite:(BOOL)overwrite completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Discussion
Changes the content of this document to the content of the given input stream.
Optional overwrite flag: If TRUE (default), then the Repository MUST replace the existing content stream for the object (if any) with the input contentStream. If FALSE, then the Repository MUST only set the input contentStream for the object if the object currently does not have a content-stream. completionBlock will return NSError nil if successful
Declared In
CMISDocument.h
deleteAllVersionsWithCompletionBlock:
Deletes the document from the document store. completionBlock return true if successful
- (CMISRequest *)deleteAllVersionsWithCompletionBlock:(void ( ^ ) ( BOOL documentDeleted , NSError *error ))completionBlock
Discussion
Deletes the document from the document store. completionBlock return true if successful
Declared In
CMISDocument.h
deleteContentWithCompletionBlock:
Deletes the content of this document. completionBlock will return NSError nil if successful
- (CMISRequest *)deleteContentWithCompletionBlock:(void ( ^ ) ( NSError *error ))completionBlock
Discussion
Deletes the content of this document. completionBlock will return NSError nil if successful
Declared In
CMISDocument.h
downloadContentToFile:completionBlock:progressBlock:
Downloads the content to a local file and returns the filepath. completionBlock will return NSError nil if successful
- (CMISRequest *)downloadContentToFile:(NSString *)filePath completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Discussion
Downloads the content to a local file and returns the filepath. completionBlock will return NSError nil if successful
Declared In
CMISDocument.h
downloadContentToOutputStream:completionBlock:progressBlock:
Downloads the content to an outputstream and returns the handle to the http request in order to allow cancellation. completionBlock will return NSError nil if successful
- (CMISRequest *)downloadContentToOutputStream:(NSOutputStream *)outputStream completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Discussion
Downloads the content to an outputstream and returns the handle to the http request in order to allow cancellation. completionBlock will return NSError nil if successful
Declared In
CMISDocument.h
retrieveAllVersionsWithCompletionBlock:
Retrieves a collection of all versions of this document. The completionBlock returns collection of all documents or nil if unsuccessful
- (CMISRequest *)retrieveAllVersionsWithCompletionBlock:(void ( ^ ) ( CMISCollection *allVersionsOfDocument , NSError *error ))completionBlock
Discussion
Retrieves a collection of all versions of this document. The completionBlock returns collection of all documents or nil if unsuccessful
Declared In
CMISDocument.h
retrieveAllVersionsWithOperationContext:completionBlock:
Retrieves a collection of all versions of this document with paging options. The completionBlock returns collection of all documents or nil if unsuccessful
- (CMISRequest *)retrieveAllVersionsWithOperationContext:(CMISOperationContext *)operationContext completionBlock:(void ( ^ ) ( CMISCollection *collection , NSError *error ))completionBlock
Discussion
Retrieves a collection of all versions of this document with paging options. The completionBlock returns collection of all documents or nil if unsuccessful
Declared In
CMISDocument.h
retrieveObjectOfLatestVersionWithMajorVersion:completionBlock:
Retrieves the lastest version of this document. The completionBlock returns the CMIS document or nil if unsuccessful
- (CMISRequest *)retrieveObjectOfLatestVersionWithMajorVersion:(BOOL)major completionBlock:(void ( ^ ) ( CMISDocument *document , NSError *error ))completionBlock
Discussion
Retrieves the lastest version of this document. The completionBlock returns the CMIS document or nil if unsuccessful
Declared In
CMISDocument.h
retrieveObjectOfLatestVersionWithMajorVersion:operationContext:completionBlock:
Retrieves the lastest version of this document with paging options. The completionBlock returns the CMIS document or nil if unsuccessful
- (CMISRequest *)retrieveObjectOfLatestVersionWithMajorVersion:(BOOL)major operationContext:(CMISOperationContext *)operationContext completionBlock:(void ( ^ ) ( CMISDocument *document , NSError *error ))completionBlock
Discussion
Retrieves the lastest version of this document with paging options. The completionBlock returns the CMIS document or nil if unsuccessful
Declared In
CMISDocument.h