CMISObjectService Protocol Reference
Conforms to | NSObject |
Declared in | CMISObjectService.h |
Tasks
-
– retrieveObject:filter:relationships:includePolicyIds:renditionFilder:includeACL:includeAllowableActions:completionBlock:
Retrieves the object with the given object identifier. completionBlock returns objectData for object or nil if unsuccessful
required method -
– retrieveObjectByPath:filter:relationships:includePolicyIds:renditionFilder:includeACL:includeAllowableActions:completionBlock:
Retrieves an object using its path. completionBlock returns objectData for object or nil if unsuccessful
required method -
– downloadContentOfObject:streamId:toFile:completionBlock:progressBlock:
Gets the content stream for the specified Document object, or gets a rendition stream for a specified rendition of a document or folder object. Downloads the content to a local file. completionBlock returns objectData for object or nil if unsuccessful
required method -
– downloadContentOfObject:streamId:toOutputStream:completionBlock:progressBlock:
Gets the content stream for the specified Document object, or gets a rendition stream for a specified rendition of a document or folder object. Downloads the content to an output stream. completionBlock returns objectData for object or nil if unsuccessful
required method -
– deleteContentOfObject:changeToken:completionBlock:
Deletes the content stream for the specified document object.
required method -
– changeContentOfObject:toContentOfFile:mimeType:overwriteExisting:changeToken:completionBlock:progressBlock:
Changes the content of the given document to the content of a given file.
required method -
– changeContentOfObject:toContentOfInputStream:bytesExpected:filename:mimeType:overwriteExisting:changeToken:completionBlock:progressBlock:
Changes the content of the given document to the content from a give input stream.
required method -
– createDocumentFromFilePath:mimeType:properties:inFolder:completionBlock:progressBlock:
uploads the file from the given path to the given folder.
required method -
– createDocumentFromInputStream:mimeType:properties:inFolder:bytesExpected:completionBlock:progressBlock:
uploads the file from the given input stream to the given folder.
required method -
– deleteObject:allVersions:completionBlock:
Deletes the given object.
required method -
– createFolderInParentFolder:properties:completionBlock:
Creates a new folder with given properties under the provided parent folder. completionBlock returns objectId for the newly created folder or nil if unsuccessful
required method -
– deleteTree:allVersion:unfileObjects:continueOnFailure:completionBlock:
Deletes the given folder and all of its subfolder and files
required method -
– updatePropertiesForObject:properties:changeToken:completionBlock:
Updates the properties of the given object. completionBlock returns NSError nil if successful
required method -
– retrieveRenditions:renditionFilter:maxItems:skipCount:completionBlock:
Gets the list of associated Renditions for the specified object. Only rendition attributes are returned, not rendition stream
required method
Instance Methods
changeContentOfObject:toContentOfFile:mimeType:overwriteExisting:changeToken:completionBlock:progressBlock:
Changes the content of the given document to the content of a given file.
- (CMISRequest *)changeContentOfObject:(CMISStringInOutParameter *)objectIdParam toContentOfFile:(NSString *)filePath mimeType:(NSString *)mimeType overwriteExisting:(BOOL)overwrite changeToken:(CMISStringInOutParameter *)changeTokenParam completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Discussion
Changes the content of the given document to the content of a given file.
It is recommended that a mime type is provided. In case no value is given – the mime type defaults to application/octet-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.
NOTE for atom pub binding: This does not return the new object id and change token as specified by the domain model. (This is not possible without introducing a new HTTP header). completionBlock – returns NSError nil if successful
Declared In
CMISObjectService.h
changeContentOfObject:toContentOfInputStream:bytesExpected:filename:mimeType:overwriteExisting:changeToken:completionBlock:progressBlock:
Changes the content of the given document to the content from a give input stream.
- (CMISRequest *)changeContentOfObject:(CMISStringInOutParameter *)objectId toContentOfInputStream:(NSInputStream *)inputStream bytesExpected:(unsigned long long)bytesExpected filename:(NSString *)filename mimeType:(NSString *)mimeType overwriteExisting:(BOOL)overwrite changeToken:(CMISStringInOutParameter *)changeToken completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Discussion
Changes the content of the given document to the content from a give input stream.
It is recommended that a mime type is provided. In case no value is given – the mime type defaults to application/octet-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.
NOTE for atom pub binding: This does not return the new object id and change token as specified by the domain model. (This is not possible without introducing a new HTTP header). completionBlock – returns NSError nil if successful
Declared In
CMISObjectService.h
createDocumentFromFilePath:mimeType:properties:inFolder:completionBlock:progressBlock:
uploads the file from the given path to the given folder.
- (CMISRequest *)createDocumentFromFilePath:(NSString *)filePath mimeType:(NSString *)mimeType properties:(CMISProperties *)properties inFolder:(NSString *)folderObjectId completionBlock:(void ( ^ ) ( NSString *objectId , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Discussion
uploads the file from the given path to the given folder.
completionBlock – returns NSError nil if successful
Declared In
CMISObjectService.h
createDocumentFromInputStream:mimeType:properties:inFolder:bytesExpected:completionBlock:progressBlock:
uploads the file from the given input stream to the given folder.
- (CMISRequest *)createDocumentFromInputStream:(NSInputStream *)inputStream mimeType:(NSString *)mimeType properties:(CMISProperties *)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
uploads the file from the given input stream to the given folder.
completionBlock – returns NSError nil if successful
Declared In
CMISObjectService.h
createFolderInParentFolder:properties:completionBlock:
Creates a new folder with given properties under the provided parent folder. completionBlock returns objectId for the newly created folder or nil if unsuccessful
- (CMISRequest *)createFolderInParentFolder:(NSString *)folderObjectId properties:(CMISProperties *)properties completionBlock:(void ( ^ ) ( NSString *objectId , NSError *error ))completionBlock
Discussion
Creates a new folder with given properties under the provided parent folder. completionBlock returns objectId for the newly created folder or nil if unsuccessful
Declared In
CMISObjectService.h
deleteContentOfObject:changeToken:completionBlock:
Deletes the content stream for the specified document object.
- (CMISRequest *)deleteContentOfObject:(CMISStringInOutParameter *)objectIdParam changeToken:(CMISStringInOutParameter *)changeTokenParam completionBlock:(void ( ^ ) ( NSError *error ))completionBlock
Discussion
Deletes the content stream for the specified document object.
A Repository MAY automatically create new Document versions as part of this service method. Therefore, the objectId output NEED NOT be identical to the objectId input
NOTE for atom pub binding: deleteContentStream: This does not return the new object id and change token as specified by the domain model. This is not possible without introducing a new HTTP header. completionBlock – returns NSError nil if successful
Declared In
CMISObjectService.h
deleteObject:allVersions:completionBlock:
Deletes the given object.
- (CMISRequest *)deleteObject:(NSString *)objectId allVersions:(BOOL)allVersions completionBlock:(void ( ^ ) ( BOOL objectDeleted , NSError *error ))completionBlock
Discussion
Deletes the given object.
The allVersions parameter is currently ignored. completionBlock returns true if successful
Declared In
CMISObjectService.h
deleteTree:allVersion:unfileObjects:continueOnFailure:completionBlock:
Deletes the given folder and all of its subfolder and files
- (CMISRequest *)deleteTree:(NSString *)folderObjectId allVersion:(BOOL)allVersions unfileObjects:(CMISUnfileObject)unfileObjects continueOnFailure:(BOOL)continueOnFailure completionBlock:(void ( ^ ) ( NSArray *failedObjects , NSError *error ))completionBlock
Discussion
Deletes the given folder and all of its subfolder and files
Returns a list of objects which failed to be deleted. completionBlock returns array of failed objects if any. NSError will be nil if successful
Declared In
CMISObjectService.h
downloadContentOfObject:streamId:toFile:completionBlock:progressBlock:
Gets the content stream for the specified Document object, or gets a rendition stream for a specified rendition of a document or folder object. Downloads the content to a local file. completionBlock returns objectData for object or nil if unsuccessful
- (CMISRequest *)downloadContentOfObject:(NSString *)objectId streamId:(NSString *)streamId toFile:(NSString *)filePath completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Discussion
Gets the content stream for the specified Document object, or gets a rendition stream for a specified rendition of a document or folder object. Downloads the content to a local file. completionBlock returns objectData for object or nil if unsuccessful
Declared In
CMISObjectService.h
downloadContentOfObject:streamId:toOutputStream:completionBlock:progressBlock:
Gets the content stream for the specified Document object, or gets a rendition stream for a specified rendition of a document or folder object. Downloads the content to an output stream. completionBlock returns objectData for object or nil if unsuccessful
- (CMISRequest *)downloadContentOfObject:(NSString *)objectId streamId:(NSString *)streamId toOutputStream:(NSOutputStream *)outputStream completionBlock:(void ( ^ ) ( NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Discussion
Gets the content stream for the specified Document object, or gets a rendition stream for a specified rendition of a document or folder object. Downloads the content to an output stream. completionBlock returns objectData for object or nil if unsuccessful
Declared In
CMISObjectService.h
retrieveObject:filter:relationships:includePolicyIds:renditionFilder:includeACL:includeAllowableActions:completionBlock:
Retrieves the object with the given object identifier. completionBlock returns objectData for object or nil if unsuccessful
- (CMISRequest *)retrieveObject:(NSString *)objectId filter:(NSString *)filter relationships:(CMISIncludeRelationship)relationships includePolicyIds:(BOOL)includePolicyIds renditionFilder:(NSString *)renditionFilter includeACL:(BOOL)includeACL includeAllowableActions:(BOOL)includeAllowableActions completionBlock:(void ( ^ ) ( CMISObjectData *objectData , NSError *error ))completionBlock
Discussion
Retrieves the object with the given object identifier. completionBlock returns objectData for object or nil if unsuccessful
Declared In
CMISObjectService.h
retrieveObjectByPath:filter:relationships:includePolicyIds:renditionFilder:includeACL:includeAllowableActions:completionBlock:
Retrieves an object using its path. completionBlock returns objectData for object or nil if unsuccessful
- (CMISRequest *)retrieveObjectByPath:(NSString *)path filter:(NSString *)filter relationships:(CMISIncludeRelationship)relationships includePolicyIds:(BOOL)includePolicyIds renditionFilder:(NSString *)renditionFilter includeACL:(BOOL)includeACL includeAllowableActions:(BOOL)includeAllowableActions completionBlock:(void ( ^ ) ( CMISObjectData *objectData , NSError *error ))completionBlock
Discussion
Retrieves an object using its path. completionBlock returns objectData for object or nil if unsuccessful
Declared In
CMISObjectService.h
retrieveRenditions:renditionFilter:maxItems:skipCount:completionBlock:
Gets the list of associated Renditions for the specified object. Only rendition attributes are returned, not rendition stream
- (CMISRequest *)retrieveRenditions:(NSString *)objectId renditionFilter:(NSString *)renditionFilter maxItems:(NSNumber *)maxItems skipCount:(NSNumber *)skipCount completionBlock:(void ( ^ ) ( NSArray *renditions , NSError *error ))completionBlock
Discussion
Gets the list of associated Renditions for the specified object. Only rendition attributes are returned, not rendition stream
Note: the paging parameters (maxItems and skipCount) are not used in the atom pub binding. Ie. the whole set is always returned. completionBlock returns array of associated renditions or nil if unsuccessful
Declared In
CMISObjectService.h
updatePropertiesForObject:properties:changeToken:completionBlock:
Updates the properties of the given object. completionBlock returns NSError nil if successful
- (CMISRequest *)updatePropertiesForObject:(CMISStringInOutParameter *)objectIdParam properties:(CMISProperties *)properties changeToken:(CMISStringInOutParameter *)changeTokenParam completionBlock:(void ( ^ ) ( NSError *error ))completionBlock
Discussion
Updates the properties of the given object. completionBlock returns NSError nil if successful
Declared In
CMISObjectService.h