AlfrescoDocumentFolderService Class Reference
Inherits from | NSObject |
Declared in | AlfrescoDocumentFolderService.h |
Overview
The AlfrescoDocumentFolderService manages folders and documents of an Alfresco repository. The service provides methods to retrieve documents and folders, but also provides methods to create and update documents and folders.
Author: Gavin Cornwell (Alfresco), Tijs Rademakers (Alfresco), Peter Schmidt (Alfresco)
Tasks
Initialisation
-
– initWithSession:
Initialises with a standard Cloud or OnPremise session
Creating folders and documents methods.
-
– createFolderWithName:inParentFolder:properties:completionBlock:
Creates a new folder using the given properties in the given folder.
-
– createFolderWithName:inParentFolder:properties:aspects:completionBlock:
Creates a new folder using the given properties in the given folder.
-
– createFolderWithName:inParentFolder:properties:aspects:type:completionBlock:
Creates a new folder using the given properties in the given folder.
-
– createDocumentWithName:inParentFolder:contentFile:properties:completionBlock:progressBlock:
Creates a new document using the contents of a local file. The new document is created within the given folder.
-
– createDocumentWithName:inParentFolder:contentFile:properties:aspects:completionBlock:progressBlock:
Creates a new document using the contents of a local file. The new document is created within the given folder.
-
– createDocumentWithName:inParentFolder:contentFile:properties:aspects:type:completionBlock:progressBlock:
Creates a new document using the contents of a local file. The new document is created within the given folder.
-
– createDocumentWithName:inParentFolder:contentStream:properties:completionBlock:progressBlock:
Creates a new document using the input stream provided. The new document is created within the given folder.
-
– createDocumentWithName:inParentFolder:contentStream:properties:aspects:completionBlock:progressBlock:
Creates a new document using the input stream provided. The new document is created within the given folder.
-
– createDocumentWithName:inParentFolder:contentStream:properties:aspects:type:completionBlock:progressBlock:
Creates a new document using the input stream provided. The new document is created within the given folder.
Retrieval methods.
-
– retrieveRootFolderWithCompletionBlock:
Called when the call completes
-
– retrievePermissionsOfNode:completionBlock:
the node for which permissions are being queried
-
– retrieveChildrenInFolder:completionBlock:
Retrieves all the children of the given folder.
-
– retrieveChildrenInFolder:listingContext:completionBlock:
Retrieves all the children of the given folder with a listing context.
-
– retrieveDocumentsInFolder:completionBlock:
Retrieves all the documents in the given folder.
-
– retrieveDocumentsInFolder:listingContext:completionBlock:
Retrieves all the documents in the given folder with a listing context.
-
– retrieveFoldersInFolder:completionBlock:
Retrieves all the sub folders in the given folder.
-
– retrieveFoldersInFolder:listingContext:completionBlock:
Retrieves all the sub folders in the given folder with a listing context
-
– retrieveNodeWithIdentifier:completionBlock:
Retrieves a document or folder with the given node identifier.
-
– retrieveNodeWithFolderPath:completionBlock:
Retrieves a node from the repository with the given folder path.
-
– retrieveNodeWithFolderPath:relativeToFolder:completionBlock:
Retrieves a node from the repository with the given folder path relative to the given folder.
-
– retrieveParentFolderOfNode:completionBlock:
Retrieves the parent folder of the given node.
-
– retrieveRenditionOfNode:renditionName:completionBlock:
Retrieves the thumbnail rendition file for the given node.
-
– retrieveRenditionOfNode:renditionName:outputStream:completionBlock:
Retrieves the thumbnail rendition file for the given node.
Updating/downloading documents and properties.
-
– retrieveContentOfDocument:completionBlock:progressBlock:
Downloads the content of the given document and stores it in the given file. The delegate object will be informed when the content is downloaded.
-
– retrieveContentOfDocument:outputStream:completionBlock:progressBlock:
Downloads the content of the given document and writes it using the provided outputstream. The delegate object will be informed when the content is downloaded.
-
– updateContentOfDocument:contentFile:completionBlock:progressBlock:
Updates a document with the contents of a local file. Versioning is not guaranteed with this method, if the document is versioned on the server the update will generate a new minor version. If a new version is required use the checkout and checkin methods in AlfrescoVersionService.
-
– updateContentOfDocument:contentStream:completionBlock:progressBlock:
Updates a document with the contents of a local stream. Versioning is not guaranteed with this method, if the document is versioned on the server the update will generate a new minor version. If a new version is required use the checkout and checkin methods in AlfrescoVersionService.
-
– updatePropertiesOfNode:properties:completionBlock:
Updates the properties of a specific node. Versioning is not guaranteed with this method, if the repository is configured to version on property changes the update will generate a new minor version. If a new version is required use the checkout and checkin methods in AlfrescoVersionService.
Deletes a node.
-
– deleteNode:completionBlock:
Deletes an individual node from the Alfresco repository.
Favorite or Unfavorite Documents, Folders, Nodes
-
– retrieveFavoriteDocumentsWithCompletionBlock:
Retrieves a list of favorite documents for current user .
-
– retrieveFavoriteDocumentsWithListingContext:completionBlock:
Retrieves a list of favorite documents with a listing context for current user.
-
– retrieveFavoriteFoldersWithCompletionBlock:
Retrieves a list of favorite folders for current user.
-
– retrieveFavoriteFoldersWithListingContext:completionBlock:
Retrieves a list of favorite folders with a listing context for current user.
-
– retrieveFavoriteNodesWithCompletionBlock:
Retrieves a list of favorite nodes for current user.
-
– retrieveFavoriteNodesWithListingContext:completionBlock:
Retrieves a list of favorite nodes with a listing context for current user.
-
– isFavorite:completionBlock:
Determine whether given node is favorite.
-
– addFavorite:completionBlock:
Favorite a node.
-
– removeFavorite:completionBlock:
UnFavorite a node.
-
– refreshNode:completionBlock:
Retrieve the latest (and complete) metadata for the provided node.
-
– clear
Clears any cached state the service has.
Instance Methods
addFavorite:completionBlock:
Favorite a node.
- (AlfrescoRequest *)addFavorite:(AlfrescoNode *)node completionBlock:(AlfrescoFavoritedCompletionBlock)completionBlock
Parameters
- node
The node which is to be favorited
- completionBlock
The block that’s called with current favorite status of the node.
Discussion
Favorite a node.
Declared In
AlfrescoDocumentFolderService.h
clear
Clears any cached state the service has.
- (void)clear
Discussion
Clears any cached state the service has.
Declared In
AlfrescoDocumentFolderService.h
createDocumentWithName:inParentFolder:contentFile:properties:aspects:completionBlock:progressBlock:
Creates a new document using the contents of a local file. The new document is created within the given folder.
- (AlfrescoRequest *)createDocumentWithName:(NSString *)documentName inParentFolder:(AlfrescoFolder *)folder contentFile:(AlfrescoContentFile *)file properties:(NSDictionary *)properties aspects:(NSArray *)aspects completionBlock:(AlfrescoDocumentCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- documentName
The name of the document to be created in the repository
- folder
The parent folder to create the document in.
- file
The local file to be uploaded.
- properties
Additional properties that are used to create the document.
- aspects
array of additional aspects to be added
- completionBlock
The block that’s called with the created document in case the operation succeeds.
- progressBlock
The block that’s called with the upload progress.
Discussion
Creates a new document using the contents of a local file. The new document is created within the given folder.
Declared In
AlfrescoDocumentFolderService.h
createDocumentWithName:inParentFolder:contentFile:properties:aspects:type:completionBlock:progressBlock:
Creates a new document using the contents of a local file. The new document is created within the given folder.
- (AlfrescoRequest *)createDocumentWithName:(NSString *)documentName inParentFolder:(AlfrescoFolder *)folder contentFile:(AlfrescoContentFile *)file properties:(NSDictionary *)properties aspects:(NSArray *)aspects type:(NSString *)type completionBlock:(AlfrescoDocumentCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- documentName
The name of the document to be created in the repository
- folder
The parent folder to create the document in.
- file
The local file to be uploaded.
- properties
Additional properties that are used to create the document.
- aspects
array of additional aspects to be added
- type
a custom property type to be added
- completionBlock
The block that’s called with the created document in case the operation succeeds.
- progressBlock
The block that’s called with the upload progress.
Discussion
Creates a new document using the contents of a local file. The new document is created within the given folder.
Declared In
AlfrescoDocumentFolderService.h
createDocumentWithName:inParentFolder:contentFile:properties:completionBlock:progressBlock:
Creates a new document using the contents of a local file. The new document is created within the given folder.
- (AlfrescoRequest *)createDocumentWithName:(NSString *)documentName inParentFolder:(AlfrescoFolder *)folder contentFile:(AlfrescoContentFile *)file properties:(NSDictionary *)properties completionBlock:(AlfrescoDocumentCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- documentName
The name of the document to be created in the repository
- folder
The parent folder to create the document in.
- file
The local file to be uploaded.
- properties
Additional properties that are used to create the document.
- completionBlock
The block that’s called with the created document in case the operation succeeds.
- progressBlock
The block that’s called with the upload progress.
Discussion
Creates a new document using the contents of a local file. The new document is created within the given folder.
Declared In
AlfrescoDocumentFolderService.h
createDocumentWithName:inParentFolder:contentStream:properties:aspects:completionBlock:progressBlock:
Creates a new document using the input stream provided. The new document is created within the given folder.
- (AlfrescoRequest *)createDocumentWithName:(NSString *)documentName inParentFolder:(AlfrescoFolder *)folder contentStream:(AlfrescoContentStream *)contentStream properties:(NSDictionary *)properties aspects:(NSArray *)aspects completionBlock:(AlfrescoDocumentCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- documentName
The name of the document to be created in the repository
- folder
The parent folder to create the document in.
- contentStream
An instance of AlfrescoContent stream to be used for data access.
- properties
Additional properties that are used to create the document.
- aspects
array of extra aspects to be added
- completionBlock
The block that’s called with the created document in case the operation succeeds.
- progressBlock
The block that’s called with the upload progress. This can only be used if the fileSize parameter is > 0.
- file
The local file to be uploaded.
Discussion
Creates a new document using the input stream provided. The new document is created within the given folder.
Declared In
AlfrescoDocumentFolderService.h
createDocumentWithName:inParentFolder:contentStream:properties:aspects:type:completionBlock:progressBlock:
Creates a new document using the input stream provided. The new document is created within the given folder.
- (AlfrescoRequest *)createDocumentWithName:(NSString *)documentName inParentFolder:(AlfrescoFolder *)folder contentStream:(AlfrescoContentStream *)contentStream properties:(NSDictionary *)properties aspects:(NSArray *)aspects type:(NSString *)type completionBlock:(AlfrescoDocumentCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- documentName
The name of the document to be created in the repository
- folder
The parent folder to create the document in.
- contentStream
An instance of AlfrescoContent stream to be used for data access.
- properties
Additional properties that are used to create the document.
- aspects
array of extra aspects to be added
- type
a custom property type to be added
- completionBlock
The block that’s called with the created document in case the operation succeeds.
- progressBlock
The block that’s called with the upload progress. This can only be used if the fileSize parameter is > 0.
- file
The local file to be uploaded.
Discussion
Creates a new document using the input stream provided. The new document is created within the given folder.
Declared In
AlfrescoDocumentFolderService.h
createDocumentWithName:inParentFolder:contentStream:properties:completionBlock:progressBlock:
Creates a new document using the input stream provided. The new document is created within the given folder.
- (AlfrescoRequest *)createDocumentWithName:(NSString *)documentName inParentFolder:(AlfrescoFolder *)folder contentStream:(AlfrescoContentStream *)contentStream properties:(NSDictionary *)properties completionBlock:(AlfrescoDocumentCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- documentName
The name of the document to be created in the repository
- folder
The parent folder to create the document in.
- contentStream
An instance of AlfrescoContent stream to be used for data access.
- properties
Additional properties that are used to create the document.
- completionBlock
The block that’s called with the created document in case the operation succeeds.
- progressBlock
The block that’s called with the upload progress. This can only be used if the fileSize parameter is > 0.
- file
The local file to be uploaded.
Discussion
Creates a new document using the input stream provided. The new document is created within the given folder.
Declared In
AlfrescoDocumentFolderService.h
createFolderWithName:inParentFolder:properties:aspects:completionBlock:
Creates a new folder using the given properties in the given folder.
- (AlfrescoRequest *)createFolderWithName:(NSString *)folderName inParentFolder:(AlfrescoFolder *)folder properties:(NSDictionary *)properties aspects:(NSArray *)aspects completionBlock:(AlfrescoFolderCompletionBlock)completionBlock
Parameters
- folderName
The name of the folder to be created.
- folder
The parent folder of the new folder.
- properties
Additional properties that are used to create the folder.
- aspects
additional aspects for this folder
- completionBlock
The block that’s called with the created folder in case the operation succeeds.
Discussion
Creates a new folder using the given properties in the given folder.
Declared In
AlfrescoDocumentFolderService.h
createFolderWithName:inParentFolder:properties:aspects:type:completionBlock:
Creates a new folder using the given properties in the given folder.
- (AlfrescoRequest *)createFolderWithName:(NSString *)folderName inParentFolder:(AlfrescoFolder *)folder properties:(NSDictionary *)properties aspects:(NSArray *)aspects type:(NSString *)type completionBlock:(AlfrescoFolderCompletionBlock)completionBlock
Parameters
- folderName
The name of the folder to be created.
- folder
The parent folder of the new folder.
- properties
Additional properties that are used to create the folder.
- aspects
additional aspects for this folder
- completionBlock
The block that’s called with the created folder in case the operation succeeds.
- custom
type of properties/aspects to be added/set to the new folder
Discussion
Creates a new folder using the given properties in the given folder.
Declared In
AlfrescoDocumentFolderService.h
createFolderWithName:inParentFolder:properties:completionBlock:
Creates a new folder using the given properties in the given folder.
- (AlfrescoRequest *)createFolderWithName:(NSString *)folderName inParentFolder:(AlfrescoFolder *)folder properties:(NSDictionary *)properties completionBlock:(AlfrescoFolderCompletionBlock)completionBlock
Parameters
- folderName
The name of the folder to be created.
- folder
The parent folder of the new folder.
- properties
Additional properties that are used to create the folder.
- completionBlock
The block that’s called with the created folder in case the operation succeeds.
Discussion
Creates a new folder using the given properties in the given folder.
Declared In
AlfrescoDocumentFolderService.h
deleteNode:completionBlock:
Deletes an individual node from the Alfresco repository.
- (AlfrescoRequest *)deleteNode:(AlfrescoNode *)node completionBlock:(AlfrescoBOOLCompletionBlock)completionBlock
Parameters
- node
The node that needs to be deleted.
- completionBlock
The block that’s called in case the operation succeeds.
Discussion
Deletes an individual node from the Alfresco repository.
Declared In
AlfrescoDocumentFolderService.h
initWithSession:
Initialises with a standard Cloud or OnPremise session
- (id)initWithSession:(id<AlfrescoSession>)session
Parameters
- session
the AlfrescoSession to initialise the site service with.
Discussion
Initialises with a standard Cloud or OnPremise session
Declared In
AlfrescoDocumentFolderService.h
isFavorite:completionBlock:
Determine whether given node is favorite.
- (AlfrescoRequest *)isFavorite:(AlfrescoNode *)node completionBlock:(AlfrescoFavoritedCompletionBlock)completionBlock
Parameters
- node
The node for which favorite status is being determined
- completionBlock
The block that’s called with current favorite status of the node.
Discussion
Determine whether given node is favorite.
Declared In
AlfrescoDocumentFolderService.h
refreshNode:completionBlock:
Retrieve the latest (and complete) metadata for the provided node.
- (AlfrescoRequest *)refreshNode:(AlfrescoNode *)node completionBlock:(AlfrescoNodeCompletionBlock)completionBlock
Parameters
- completionBlock
The block that’s called with node’s complete metadata.
- The
node which is to be refreshed with its latest metadata
Discussion
Retrieve the latest (and complete) metadata for the provided node.
Declared In
AlfrescoDocumentFolderService.h
removeFavorite:completionBlock:
UnFavorite a node.
- (AlfrescoRequest *)removeFavorite:(AlfrescoNode *)node completionBlock:(AlfrescoFavoritedCompletionBlock)completionBlock
Parameters
- node
The node which is to be unfavorited
- completionBlock
The block that’s called with current favorite status of the node.
Discussion
UnFavorite a node.
Declared In
AlfrescoDocumentFolderService.h
retrieveChildrenInFolder:completionBlock:
Retrieves all the children of the given folder.
- (AlfrescoRequest *)retrieveChildrenInFolder:(AlfrescoFolder *)folder completionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- folder
The folder for which the children are retrieved.
- completionBlock
The block that’s called with the retrieved children in case the operation succeeds.
Discussion
Retrieves all the children of the given folder.
Declared In
AlfrescoDocumentFolderService.h
retrieveChildrenInFolder:listingContext:completionBlock:
Retrieves all the children of the given folder with a listing context.
- (AlfrescoRequest *)retrieveChildrenInFolder:(AlfrescoFolder *)folder listingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- folder
The folder for which the children are retrieved.
- listingContext
The listing context with a paging definition that’s used to retrieve the children.
- completionBlock
The block that’s called with the retrieved children in case the operation succeeds.
Discussion
Retrieves all the children of the given folder with a listing context.
Declared In
AlfrescoDocumentFolderService.h
retrieveContentOfDocument:completionBlock:progressBlock:
Downloads the content of the given document and stores it in the given file. The delegate object will be informed when the content is downloaded.
- (AlfrescoRequest *)retrieveContentOfDocument:(AlfrescoDocument *)document completionBlock:(AlfrescoContentFileCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- document
The document that needs to be downloaded.
- completionBlock
The block containing an AlfrescoContentFile and NSError object. error will be nil if successful. Otherwise, AlfrescoContentFile will be nil.
- progressBlock
The block that’s called with the download progress.
Discussion
Downloads the content of the given document and stores it in the given file. The delegate object will be informed when the content is downloaded.
Declared In
AlfrescoDocumentFolderService.h
retrieveContentOfDocument:outputStream:completionBlock:progressBlock:
Downloads the content of the given document and writes it using the provided outputstream. The delegate object will be informed when the content is downloaded.
- (AlfrescoRequest *)retrieveContentOfDocument:(AlfrescoDocument *)document outputStream:(NSOutputStream *)outputStream completionBlock:(AlfrescoBOOLCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- document
The document that needs to be downloaded.
- outputStream
The stream used to write the contents to disk.
- completionBlock
The block containing an AlfrescoContentFile and NSError object. error will be nil if successful. Otherwise, AlfrescoContentFile will be nil.
- progressBlock
The block that’s called with the download progress.
Discussion
Downloads the content of the given document and writes it using the provided outputstream. The delegate object will be informed when the content is downloaded.
Declared In
AlfrescoDocumentFolderService.h
retrieveDocumentsInFolder:completionBlock:
Retrieves all the documents in the given folder.
- (AlfrescoRequest *)retrieveDocumentsInFolder:(AlfrescoFolder *)folder completionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- folder
The folder for which the documents are retrieved.
- completionBlock
The block that’s called with the retrieved documents in case the operation succeeds.
Discussion
Retrieves all the documents in the given folder.
Declared In
AlfrescoDocumentFolderService.h
retrieveDocumentsInFolder:listingContext:completionBlock:
Retrieves all the documents in the given folder with a listing context.
- (AlfrescoRequest *)retrieveDocumentsInFolder:(AlfrescoFolder *)folder listingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- folder
The folder for which the documents are retrieved.
- listingContext
The listing context with a paging definition that’s used to retrieve the documents.
- completionBlock
The block that’s called with the retrieved documents in case the operation succeeds.
Discussion
Retrieves all the documents in the given folder with a listing context.
Declared In
AlfrescoDocumentFolderService.h
retrieveFavoriteDocumentsWithCompletionBlock:
Retrieves a list of favorite documents for current user .
- (AlfrescoRequest *)retrieveFavoriteDocumentsWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- completionBlock
The block that’s called with the retrieved documents in case the operation succeeds.
Discussion
Retrieves a list of favorite documents for current user .
Declared In
AlfrescoDocumentFolderService.h
retrieveFavoriteDocumentsWithListingContext:completionBlock:
Retrieves a list of favorite documents with a listing context for current user.
- (AlfrescoRequest *)retrieveFavoriteDocumentsWithListingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- listingContext
The listing context with a paging definition that’s used to retrieve favorite documents.
- completionBlock
The block that’s called with the retrieved documents in case the operation succeeds.
Discussion
Retrieves a list of favorite documents with a listing context for current user.
Declared In
AlfrescoDocumentFolderService.h
retrieveFavoriteFoldersWithCompletionBlock:
Retrieves a list of favorite folders for current user.
- (AlfrescoRequest *)retrieveFavoriteFoldersWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- completionBlock
The block that’s called with the retrieved folders in case the operation succeeds.
Discussion
Retrieves a list of favorite folders for current user.
Declared In
AlfrescoDocumentFolderService.h
retrieveFavoriteFoldersWithListingContext:completionBlock:
Retrieves a list of favorite folders with a listing context for current user.
- (AlfrescoRequest *)retrieveFavoriteFoldersWithListingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- listingContext
The listing context with a paging definition that’s used to retrieve favorite folders.
- completionBlock
The block that’s called with the retrieved folders in case the operation succeeds.
Discussion
Retrieves a list of favorite folders with a listing context for current user.
Declared In
AlfrescoDocumentFolderService.h
retrieveFavoriteNodesWithCompletionBlock:
Retrieves a list of favorite nodes for current user.
- (AlfrescoRequest *)retrieveFavoriteNodesWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- completionBlock
The block that’s called with the retrieved nodes in case the operation succeeds.
Discussion
Retrieves a list of favorite nodes for current user.
Declared In
AlfrescoDocumentFolderService.h
retrieveFavoriteNodesWithListingContext:completionBlock:
Retrieves a list of favorite nodes with a listing context for current user.
- (AlfrescoRequest *)retrieveFavoriteNodesWithListingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- listingContext
The listing context with a paging definition that’s used to retrieve favorite nodes.
- completionBlock
The block that’s called with the retrieved nodes in case the operation succeeds.
Discussion
Retrieves a list of favorite nodes with a listing context for current user.
Declared In
AlfrescoDocumentFolderService.h
retrieveFoldersInFolder:completionBlock:
Retrieves all the sub folders in the given folder.
- (AlfrescoRequest *)retrieveFoldersInFolder:(AlfrescoFolder *)folder completionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- folder
The folder for which the sub folders are retrieved.
- completionBlock
The block that’s called with the retrieved sub folders in case the operation succeeds.
Discussion
Retrieves all the sub folders in the given folder.
Declared In
AlfrescoDocumentFolderService.h
retrieveFoldersInFolder:listingContext:completionBlock:
Retrieves all the sub folders in the given folder with a listing context
- (AlfrescoRequest *)retrieveFoldersInFolder:(AlfrescoFolder *)folder listingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- folder
The folder for which the sub folders are retrieved.
- listingContext
The listing context with a paging definition that’s used to retrieve the sub folders.
- completionBlock
The block that’s called with the retrieved sub folders in case the operation succeeds.
Discussion
Retrieves all the sub folders in the given folder with a listing context
Declared In
AlfrescoDocumentFolderService.h
retrieveNodeWithFolderPath:completionBlock:
Retrieves a node from the repository with the given folder path.
- (AlfrescoRequest *)retrieveNodeWithFolderPath:(NSString *)path completionBlock:(AlfrescoNodeCompletionBlock)completionBlock
Parameters
- path
The folder path that’s used to query for a specific node.
- completionBlock
The block that’s called with the retrieved node in case the operation succeeds.
Discussion
Retrieves a node from the repository with the given folder path.
An folder path can be for example:
/important.docx /work/example.pptx
Declared In
AlfrescoDocumentFolderService.h
retrieveNodeWithFolderPath:relativeToFolder:completionBlock:
Retrieves a node from the repository with the given folder path relative to the given folder.
- (AlfrescoRequest *)retrieveNodeWithFolderPath:(NSString *)path relativeToFolder:(AlfrescoFolder *)folder completionBlock:(AlfrescoNodeCompletionBlock)completionBlock
Parameters
- path
The folder path that’s used to query for a specific node.
- folder
The root folder that’s used to query for a specific node.
- completionBlock
The block that’s called with the retrieved node in case the operation succeeds.
Discussion
Retrieves a node from the repository with the given folder path relative to the given folder.
Declared In
AlfrescoDocumentFolderService.h
retrieveNodeWithIdentifier:completionBlock:
Retrieves a document or folder with the given node identifier.
- (AlfrescoRequest *)retrieveNodeWithIdentifier:(NSString *)identifier completionBlock:(AlfrescoNodeCompletionBlock)completionBlock
Parameters
- identifier
The node identifier that’s used to query for a specific node.
- completionBlock
The block that’s called with the retrieved node in case the operation succeeds.
Discussion
Retrieves a document or folder with the given node identifier.
Declared In
AlfrescoDocumentFolderService.h
retrieveParentFolderOfNode:completionBlock:
Retrieves the parent folder of the given node.
- (AlfrescoRequest *)retrieveParentFolderOfNode:(AlfrescoNode *)node completionBlock:(AlfrescoFolderCompletionBlock)completionBlock
Parameters
- node
The node for which the parent folder is retrieved.
- completionBlock
The block that’s called with the retrieved parent folder in case the operation succeeds.
Discussion
Retrieves the parent folder of the given node.
Declared In
AlfrescoDocumentFolderService.h
retrievePermissionsOfNode:completionBlock:
the node for which permissions are being queried
- (AlfrescoRequest *)retrievePermissionsOfNode:(AlfrescoNode *)node completionBlock:(AlfrescoPermissionsCompletionBlock)completionBlock
Parameters
- node
the node for which permissions are being queried
- completionBlock
the block returns an AlfrescoPermissions and NSError object)
Return Value
the AlfrescoRequest object. If the node has an associated AlfrescoPermissions object, a network request for the node will not be necessary, and the method will return a nil AlfrescoRequest object.
Declared In
AlfrescoDocumentFolderService.h
retrieveRenditionOfNode:renditionName:completionBlock:
Retrieves the thumbnail rendition file for the given node.
- (AlfrescoRequest *)retrieveRenditionOfNode:(AlfrescoNode *)node renditionName:(NSString *)renditionName completionBlock:(AlfrescoContentFileCompletionBlock)completionBlock
Parameters
- node
the AlfrescoNode for which a thumbnail rendition image is to be retrieved.
- renditionName
The type of thumbnail to be retrieved. For example ‘doclib’ can be used (defined as AlfrescoThumbnailRendition )
- completionBlock
The block that’s called with the local AlfrescoContentFile containing the thumbnail URL/data.
Discussion
Retrieves the thumbnail rendition file for the given node.
Declared In
AlfrescoDocumentFolderService.h
retrieveRenditionOfNode:renditionName:outputStream:completionBlock:
Retrieves the thumbnail rendition file for the given node.
- (AlfrescoRequest *)retrieveRenditionOfNode:(AlfrescoNode *)node renditionName:(NSString *)renditionName outputStream:(NSOutputStream *)outputStream completionBlock:(AlfrescoBOOLCompletionBlock)completionBlock
Parameters
- node
the AlfrescoNode for which a thumbnail rendition image is to be retrieved.
- renditionName
The type of thumbnail to be retrieved. For example ‘doclib’ can be used (defined as AlfrescoThumbnailRendition )
- outputStream
The output stream to which the rendition image will be written to.
- completionBlock
The block that’s called with the local AlfrescoContentFile containing the thumbnail URL/data.
Discussion
Retrieves the thumbnail rendition file for the given node.
Declared In
AlfrescoDocumentFolderService.h
retrieveRootFolderWithCompletionBlock:
Called when the call completes
- (AlfrescoRequest *)retrieveRootFolderWithCompletionBlock:(AlfrescoFolderCompletionBlock)completionBlock
Parameters
- completionBlock
Called when the call completes
Declared In
AlfrescoDocumentFolderService.h
updateContentOfDocument:contentFile:completionBlock:progressBlock:
Updates a document with the contents of a local file. Versioning is not guaranteed with this method, if the document is versioned on the server the update will generate a new minor version. If a new version is required use the checkout and checkin methods in AlfrescoVersionService.
- (AlfrescoRequest *)updateContentOfDocument:(AlfrescoDocument *)document contentFile:(AlfrescoContentFile *)file completionBlock:(AlfrescoDocumentCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- document
The document that needs to be updated.
- completionBlock
The block that’s called with the updated document in case the operation succeeds.
- progressBlock
The block that’s called with the upload progress.
- contentFile
The Alfresco Content File to be updated.
Discussion
Updates a document with the contents of a local file. Versioning is not guaranteed with this method, if the document is versioned on the server the update will generate a new minor version. If a new version is required use the checkout and checkin methods in AlfrescoVersionService.
Declared In
AlfrescoDocumentFolderService.h
updateContentOfDocument:contentStream:completionBlock:progressBlock:
Updates a document with the contents of a local stream. Versioning is not guaranteed with this method, if the document is versioned on the server the update will generate a new minor version. If a new version is required use the checkout and checkin methods in AlfrescoVersionService.
- (AlfrescoRequest *)updateContentOfDocument:(AlfrescoDocument *)document contentStream:(AlfrescoContentStream *)contentStream completionBlock:(AlfrescoDocumentCompletionBlock)completionBlock progressBlock:(AlfrescoProgressBlock)progressBlock
Parameters
- document
The document that needs to be updated.
- contentStream
An instance of AlfrescoContent stream to be used for data access.
- completionBlock
The block that’s called with the updated document in case the operation succeeds.
- progressBlock
The block that’s called with the upload progress. This can only be used if the fileSize parameter is > 0.
Discussion
Updates a document with the contents of a local stream. Versioning is not guaranteed with this method, if the document is versioned on the server the update will generate a new minor version. If a new version is required use the checkout and checkin methods in AlfrescoVersionService.
Declared In
AlfrescoDocumentFolderService.h
updatePropertiesOfNode:properties:completionBlock:
Updates the properties of a specific node. Versioning is not guaranteed with this method, if the repository is configured to version on property changes the update will generate a new minor version. If a new version is required use the checkout and checkin methods in AlfrescoVersionService.
- (AlfrescoRequest *)updatePropertiesOfNode:(AlfrescoNode *)node properties:(NSDictionary *)properties completionBlock:(AlfrescoNodeCompletionBlock)completionBlock
Parameters
- node
The node that needs to be updated.
- properties
The properties that need to be updated for the given node.
- completionBlock
The block that’s called with the updated node in case the operation succeeds.
Discussion
Updates the properties of a specific node. Versioning is not guaranteed with this method, if the repository is configured to version on property changes the update will generate a new minor version. If a new version is required use the checkout and checkin methods in AlfrescoVersionService.
Declared In
AlfrescoDocumentFolderService.h