CMISVersioningService Protocol Reference
Conforms to | NSObject |
Declared in | CMISVersioningService.h |
Tasks
-
– retrieveObjectOfLatestVersion:major:filter:relationships:includePolicyIds:renditionFilter:includeACL:includeAllowableActions:completionBlock:
required method -
– retrieveAllVersions:filter:includeAllowableActions:completionBlock:
required method -
– checkOut:completionBlock:
required method -
– cancelCheckOut:completionBlock:
required method -
– checkIn:asMajorVersion:filePath:mimeType:properties:checkinComment:completionBlock:progressBlock:
required method -
– checkIn:asMajorVersion:inputStream:bytesExpected:mimeType:properties:checkinComment:completionBlock:progressBlock:
required method
Instance Methods
cancelCheckOut:completionBlock:
Reverses the effect of a check-out.
- (CMISRequest *)cancelCheckOut:(NSString *)objectId completionBlock:(void ( ^ ) ( BOOL checkOutCancelled , NSError *error ))completionBlock
Parameters
- completionBlock
returns object data or nil
Discussion
Reverses the effect of a check-out.
@param objectId
Declared In
CMISVersioningService.h
checkIn:asMajorVersion:filePath:mimeType:properties:checkinComment:completionBlock:progressBlock:
Checks-in the private working copy (PWC) document from the given path.
- (CMISRequest *)checkIn:(NSString *)objectId asMajorVersion:(BOOL)asMajorVersion filePath:(NSString *)filePath mimeType:(NSString *)mimeType properties:(CMISProperties *)properties checkinComment:(NSString *)checkinComment completionBlock:(void ( ^ ) ( CMISObjectData *objectData , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Parameters
- objectId
the identifier for the PWC
- asMajorVersion
indicator if the new version should become a major (YES) or minor (NO) version
- filePath
(optional) Path to the file containing the content to be uploaded
- mimeType
(optional) Mime type of the content to be uploaded
- properties
(optional) the property values that must be applied to the checked-in document object
- checkinComment
(optional) a version comment
- completionBlock
returns object data or nil
- progressBlock
periodic file upload status
Discussion
Checks-in the private working copy (PWC) document from the given path.
Declared In
CMISVersioningService.h
checkIn:asMajorVersion:inputStream:bytesExpected:mimeType:properties:checkinComment:completionBlock:progressBlock:
Checks-in the private working copy (PWC) document from the given an input stream.
- (CMISRequest *)checkIn:(NSString *)objectId asMajorVersion:(BOOL)asMajorVersion inputStream:(NSInputStream *)inputStream bytesExpected:(unsigned long long)bytesExpected mimeType:(NSString *)mimeType properties:(CMISProperties *)properties checkinComment:(NSString *)checkinComment completionBlock:(void ( ^ ) ( CMISObjectData *objectData , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesUploaded , unsigned long long bytesTotal ))progressBlock
Parameters
- objectId
the identifier for the PWC
- asMajorVersion
indicator if the new version should become a major (YES) or minor (NO) version
- inputStream
(optional) Input stream containing the content to be uploaded
- bytesExpected
The size of content to be uploaded (must be provided if an inputStream is given)
- mimeType
(optional) Mime type of the content to be uploaded
- properties
(optional) the property values that must be applied to the checked-in document object
- checkinComment
(optional) a version comment
- completionBlock
returns object data or nil
- progressBlock
periodic file upload status
Discussion
Checks-in the private working copy (PWC) document from the given an input stream.
Declared In
CMISVersioningService.h
checkOut:completionBlock:
Create a private working copy of a document given an object identifier.
- (CMISRequest *)checkOut:(NSString *)objectId completionBlock:(void ( ^ ) ( CMISObjectData *objectData , NSError *error ))completionBlock
Parameters
- completionBlock
returns PWC object data or nil
Discussion
Create a private working copy of a document given an object identifier.
@param objectId
Declared In
CMISVersioningService.h
retrieveAllVersions:filter:includeAllowableActions:completionBlock:
Returns the list of all Document Object in the given version series, sorted by creationDate descending (ie youngest first) @param objectId @param filter @param includeAllowableActions
- (CMISRequest *)retrieveAllVersions:(NSString *)objectId filter:(NSString *)filter includeAllowableActions:(BOOL)includeAllowableActions completionBlock:(void ( ^ ) ( NSArray *objects , NSError *error ))completionBlock
Parameters
- completionBlock
returns array of all versioned objects or nil otherwise
Discussion
Returns the list of all Document Object in the given version series, sorted by creationDate descending (ie youngest first) @param objectId @param filter @param includeAllowableActions
Declared In
CMISVersioningService.h
retrieveObjectOfLatestVersion:major:filter:relationships:includePolicyIds:renditionFilter:includeACL:includeAllowableActions:completionBlock:
Get a the latest Document object in the Version Series. @param objectId @param major @param filter @param includeRelationships @param includePolicyIds @param renditionFilter @param includeACL @param includeAllowableActions
- (CMISRequest *)retrieveObjectOfLatestVersion:(NSString *)objectId major:(BOOL)major filter:(NSString *)filter relationships:(CMISIncludeRelationship)relationships includePolicyIds:(BOOL)includePolicyIds renditionFilter:(NSString *)renditionFilter includeACL:(BOOL)includeACL includeAllowableActions:(BOOL)includeAllowableActions completionBlock:(void ( ^ ) ( CMISObjectData *objectData , NSError *error ))completionBlock
Parameters
- completionBlock
returns object data if found or nil otherwise
Discussion
Get a the latest Document object in the Version Series. @param objectId @param major @param filter @param includeRelationships @param includePolicyIds @param renditionFilter @param includeACL @param includeAllowableActions
Declared In
CMISVersioningService.h