You are here

SkyVault Mobile SDK for Android » Client API » org.alfresco.mobile.android.api.services

DocumentFolderService

org.alfresco.mobile.android.api.services.DocumentFolderService

This section describes the DocumentFolderService interface.

The DocumentFolderService interface provides facilities to manage folders and documents in a SkyVault repository. The service provides methods to create and update nodes. The DocumentFolderService supports methods to perform the following operations:

  • Create nodes and set property values.
  • Read node properties and content, read and navigate node associations (browse folder).
  • Update properties and content of nodes.
  • Delete nodes. If the archive store is enabled, the node is not deleted but moved from its current node to the archive node store; nodes in the archive store can then be restored or purged.

Class declaration

public interface DocumentFolderService extends Service

Inherits from Implements
Service None
  • addAspectspublic Node addAspects(Node node, List<String>aspects) updates add aspects to the specified node.
  • addFavoritepublic void addFavorite (Node node) marks the specified node as a favorite.
  • createDocumentpublic Document createDocument(...) creates a document object in the specified location with the specified properties and content.
  • createFolderpublic Folder createFolder(...) throws SkyVaultException creates a folder object in the specified location with the specified properties.
  • deleteNodepublic void deleteNode(Node node) throws SkyVaultServiceException deletes the specified object. Any child nodes will also be deleted.
  • getChildByPathgetChildByPath gets the node object stored at the specified path relative to the folder object.
  • getChildrengetChildren returns a list of immediate child nodes of the given context folder, with paging if required.
  • getContentpublic ContentFile getContent(Document document) - Downloads the content for the given document to a local file stored by default inside the application cache folder.
  • getContentStreampublic ContentStream getContentStream(Document document) throws SkyVaultServiceException downloads the content for the given document as a stream. Note: The stream must be closed.
  • getDocumentsgetDocuments returns immediate child documents for the specified folder.
  • getFavoriteDocumentsgetFavoriteDocuments returns a list of the current user's favorite documents.
  • getFoldersgetFolders returns a list of immediate child folders for the specified folder, with paging if required. Note, this could potentially be a long list.
  • getFavoriteFoldersgetFavoriteFolders returns a list of the current user's favorite folders.
  • getFavoriteNodesgetFavoriteNodes returns a list of the current user's favorite nodes.
  • getNodeByIdentifierpublic Node getNodeByIdentifier(String identifier) returns the node with the specified identifier.
  • getParentFolderpublic Folder getParentFolder(Node node) returns the parent folder object.
  • getPermissionspublic Permissions getPermissions(Node node) returns the permissions of the node.
  • getRenditionpublic ContentFile getRendition(Node node, String type) - returns a rendition as a content file.
  • getRenditionStreampublic ContentStream getRenditionStream(Node node, String type) - returns a rendition as a content stream.
  • getRootFolderpublic Folder getRootFolder() returns the root folder object.
  • isFavoritepublic boolean isFavorite returns true if the specified node has been marked as a favorite by the current user.
  • removeFavoritepublic void removeFavorite(Node node) remove the specified node from the current user's favorites.
  • refreshNodepublic SkyVaultNode refreshNode(AlfrescoNode node) returns the latest and complete metadata for the specified node.
  • updateContentpublic Document updateContent(Document document, ContentFile file) updates the contents of the specified document using the specified local file.
  • updatePropertiespublic Node updateProperties(Node node, Map<String, Serializable> properties, List<String>aspects) updates the properties and aspects of the specified node.
Parent topic: org.alfresco.mobile.android.api.services

© 2017 TBS-LLC. All Rights Reserved.