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:
-
– retrieveAllVersionsWithOperationContext:completionBlock:
-
– retrieveObjectOfLatestVersionWithMajorVersion:completionBlock:
-
– retrieveObjectOfLatestVersionWithMajorVersion:operationContext:completionBlock:
-
– downloadContentToFile:completionBlock:progressBlock:
-
– downloadContentToOutputStream:completionBlock:progressBlock:
-
– downloadContentToFile:offset:length:completionBlock:progressBlock:
-
– downloadContentToOutputStream:offset:length:completionBlock:progressBlock:
-
– changeContentToContentOfFile:mimeType:overwrite:completionBlock:progressBlock:
-
– changeContentToContentOfInputStream:bytesExpected:fileName:mimeType:overwrite:completionBlock:progressBlock:
-
– deleteContentWithCompletionBlock:
-
– deleteAllVersionsWithCompletionBlock:
-
– checkOutWithCompletionBlock:
-
– cancelCheckOutWithCompletionBlock:
-
– checkInAsMajorVersion:filePath:mimeType:properties:checkinComment:completionBlock:progressBlock:
-
– checkInAsMajorVersion:inputStream:bytesExpected:mimeType:properties:checkinComment:completionBlock:progressBlock:
Properties
Instance Methods
cancelCheckOutWithCompletionBlock:
Cancel checkout if this is a PWC
- (CMISRequest *)cancelCheckOutWithCompletionBlock:(void ( ^ ) ( BOOL checkoutCancelled , NSError *error ))completionBlock
Discussion
Cancel checkout if this is a PWC
Declared In
CMISDocument.h
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
checkInAsMajorVersion:filePath:mimeType:properties:checkinComment:completionBlock:progressBlock:
Checkin this PWC from a specified file path and return the checked-in document
- (CMISRequest *)checkInAsMajorVersion:(BOOL)majorVersion filePath:(NSString *)filePath mimeType:(NSString *)mimeType properties:(CMISProperties *)properties checkinComment:(NSString *)checkinComment completionBlock:(void ( ^ ) ( CMISDocument *document , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Discussion
Checkin this PWC from a specified file path and return the checked-in document
Declared In
CMISDocument.h
checkInAsMajorVersion:inputStream:bytesExpected:mimeType:properties:checkinComment:completionBlock:progressBlock:
Checkin this PWC from a specified input stream and return the checked-in document
- (CMISRequest *)checkInAsMajorVersion:(BOOL)majorVersion inputStream:(NSInputStream *)inputStream bytesExpected:(unsigned long long)bytesExpected mimeType:(NSString *)mimeType properties:(CMISProperties *)properties checkinComment:(NSString *)checkinComment completionBlock:(void ( ^ ) ( CMISDocument *document , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Discussion
Checkin this PWC from a specified input stream and return the checked-in document
Declared In
CMISDocument.h
checkOutWithCompletionBlock:
Checkout the document and return the PWC via the completion block
- (CMISRequest *)checkOutWithCompletionBlock:(void ( ^ ) ( CMISDocument *privateWorkingCopy , NSError *error ))completionBlock
Discussion
Checkout the document and return the PWC via the completion block
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
downloadContentToFile:offset:length:completionBlock:progressBlock:
Downloads the content to a local file and returns the filepath. completionBlock will return NSError nil if successful Provides options to resume download
- (CMISRequest *)downloadContentToFile:(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 to a local file and returns the filepath. completionBlock will return NSError nil if successful Provides options to resume download
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
downloadContentToOutputStream:offset:length: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 Provides options to resume download
- (CMISRequest *)downloadContentToOutputStream:(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 to an outputstream and returns the handle to the http request in order to allow cancellation. completionBlock will return NSError nil if successful Provides options to resume download
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 latest 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 latest version of this document. The completionBlock returns the CMIS document or nil if unsuccessful
Declared In
CMISDocument.h
retrieveObjectOfLatestVersionWithMajorVersion:operationContext:completionBlock:
Retrieves the latest 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 latest version of this document with paging options. The completionBlock returns the CMIS document or nil if unsuccessful
Declared In
CMISDocument.h