This topic lists the main classes that comprise the iOS Remote
API.
Constants
| Class | Description |
|---|---|
| SkyVaultConstants | The SkyVaultConstants class contains various useful constants. |
File Manager
| Class | Description |
|---|---|
| SkyVaultFileManager | The SkyVaultFileManager class exposes methods to perform file and directory operations. |
Model
| Class | Description |
|---|---|
| SkyVaultActivityEntry | The SkyVaultActivityEntry class represents an activity in an SkyVault repository |
| SkyVaultComment | The SkyVaultComment class represents a comment that is attached to a node in a SkyVault repository |
| SkyVaultContentFile | The SkyVaultContentFile class is used for download/upload of content |
| SkyVaultContentStream | The SkyVaultContentStream class is used for download/upload of content as a stream |
| SkyVaultDocument | The SkyVaultDocument class represents a document in an SkyVault repository |
| SkyVaultFolder | The SkyVaultFolder class represents a folder in a SkyVault repository |
| SkyVaultKeywordSearchOptions | The SkyVaultKeywordSearchOptions class are used in SkyVault Search Service |
| SkyVaultListingContext | The SkyVaultListingContext class can be used to specify paging values |
| SkyVaultListingFilter | The SkyVaultListingFilter class can be used to specify filtering values for paged results |
| SkyVaultNode | The SkyVaultNode class represents a node that is stored in the SkyVault repository |
| SkyVaultPagingResult | The SkyVaultPagingResult class is used to return a paged result of a query against the repository |
| SkyVaultPermissions | The SkyVaultPermissions class holds the doable actions for nodes (documents/folders) |
| SkyVaultPerson | The SkyVaultPerson class represents a user in a SkyVault repository |
| SkyVaultProperty | The SkyVaultProperty class represents a property that is associated with a specific node |
| SkyVaultRepositoryCapabilities | The SkyVaultRepositoryCapabilities is used as a property on SkyVaultRepositoryInfo |
| SkyVaultRepositoryInfo | The SkyVaultRepositoryInfo class holds the information for a specific SkyVault repository |
| SkyVaultSearchLanguage | The SkyVaultSearchLanguage enum specifies the search language used. |
| SkyVaultSite | The SkyVaultSite class represents a site in a SkyVault repository |
| SkyVaultSiteVisibility | The SkyVaultSiteVisibility enum is used to define whether a site is Public, Moderated or Private. |
| SkyVaultTag | The SkyVaultTag class represents a tag applied to a document in the repository. |
| SkyVaultWorkflowProcess | The SkyVaultWorkflowProcess class represents a workflow process. |
| SkyVaultWorkflowProcessDefinition | The SkyVaultWorkflowProcessDefinition class represents a workflow process definition. |
| SkyVaultWorkflowTask | The SkyVaultWorkflowTask class represents a workflow task. |
Attention: In version 1.4 of the SDK numerous additions were made to the model,
based around classes related to Model Definition and
Config. For sake of brevity, these are not listed in the
above table.
Services
| Class | Description |
|---|---|
| SkyVaultActivityStreamService | The SkyVaultActivityStreamService class provides various ways to retrieve an activity stream |
| SkyVaultCommentService | The SkyVaultCommentService class manages comments on nodes in a SkyVault repository. The service provides CRUD methods to work with comments |
| SkyVaultConfigService | The SkyVaultConfigService class manages all aspects of configuration. |
| SkyVaultDocumentFolderService | The SkyVaultDocumentFolderService class manages folders and documents of a SkyVault repository. The service provides methods to retrieve documents and folders, but also provides methods to create and update documents and folders. |
| SkyVaultPersonService | The SkyVaultPersonService class is used to obtain details about registered users |
| SkyVaultRatingService | The SkyVaultRatingService class provides the facility to allow users to like and/or dislike nodes |
| SkyVaultSearchService | The SkyVaultSearchService class is used to performs a search based on the search statement and given query language. Query language can be CMIS SQL. For this a valid CMIS SQL statement needs to be passed to the method. The alternative is to use a space delimited keyword string |
| SkyVaultSiteService | The SkyVaultSiteService class provides various ways to retrieve sites from a SkyVault repository |
| SkyVaultTaggingService | The SkyVaultTaggingService class provides various ways to retrieve tags and can add tags to a node in a SkyVault repository. |
| SkyVaultVersionService | The SkyVaultVersionService class provides ways to get all versions of a specific document |
| SkyVaultWorkflowService | The SkyVaultWorkflowService class provides ways to create and manage Activiti (and jBPM) workflows. |
Session
| Class | Description |
|---|---|
| SkyVaultCloudNetwork | The SkyVaultCloudNetwork class exposes properties for cloud repositories. |
| SkyVaultCloudSession | The SkyVaultCloudSession class exposes properties and methods for a connection to a cloud repository. |
| SkyVaultOAuthData | The SkyVaultOAuthData class encapsulates OAuth data. |
| SkyVaultOAuthHelper | The SkyVaultOAuthHelper class provides helper methods for dealing with OAuth data. |
| SkyVaultRepositorySession | The SkyVaultRepositorySession class encapsulates methods to manipulate on-premise repository sessions. |
| SkyVaultSession | The SkyVaultSession class is the parent class for sessions. |
Utils
| Class | Description |
|---|---|
| SkyVaultRequest | The SkyVaultRequest class exposes methods to manage a request, in particular to cancel a request in progress. |
| SkyVaultLog | The SkyVaultLog class exposes methods to write various types of logging message. |