Classes

  ClassDescription
CheckinCompletedEventArgs
Provides data for CheckinCompleted which is raised when checkin operation was completed.
  • Result Result Item for applying checkin configuration after uploading files to vault.
  • Error Information on error that occured while checkin.
  • Cancelled Boolean value. Shows if checkin operation was cancelled.
  • UserState May contain additional information. Usually contains Item configuration for which checkin action was called.
CheckinManager
CheckinProgressChangedEventArgs
Provides data for CheckinProgressChanged event which is raised when one of the steps of checkin operation was completed.
  • ProgressPercentage Current progress of operation in percents.
  • UserState Contains additional information for action. Usually initial checkin configuration.
CheckoutManager
Provide methods for locking all required items in the specified configuration of items and for synchronous and asynchronous downloading of all the files in the configuration.
DownloadFileCompletedEventArgs
Provides data for DownloadFileCompleted event which is raised when a single file download is complete.
DownloadFilesCompletedEventArgs
Provides data for DownloadFilesCompleted event which is raised when either all file downloads are complete or when the operation was cancled by user.
DownloadFilesProgressChangedEventArgs
Provides data for DownloadFilesProgressChanged event which is raised when the progress percentage is changed.
DownloadResult
Represents result of a single file download.
InvalidConflictDetectionResult
Class represents invalid ConflictDetection result exception.
ItemErrorException
Exception which wrap error Item
MultiParentConfigurationBuilder
This ItemConfigurationBuilder allows to add parent Items for all Items in configuration
UploadFileCompletedEventArgs
Provides data for UploadFileCompleted event which is raised when uploading of a single file to vault was completed.
  • Result Result Item for uploading file to vault.
  • Error Information on error that occured while uploading file.
  • Cancelled Boolean value. Shows if upload operation was cancelled.
  • UserState May contain additional information. Usually id of the file for which upload operation was completed.
UploadFilesCompletedEventArgs
Provides information for UploadFilesCompleted event which is raised when uploading of all files in configuration was completed.
  • Result Returns hashtable with the results of uploading files to vault. Key is the id of uploaded file, value is the instance of UploadResult class.
  • Error Information on error that occured while uploading files.
  • Cancelled Boolean value. Shows if upload operation was cancelled.
  • UserState May contain additional information. Usually initial checkin configuration.
UploadFilesProgressChangedEventArgs
Provides data for UploadFilesProgressChanged event which is raised when the progress percentage is changed (a file is uploaded to vault).
UploadResult
Represents result of a single file upload.

Interfaces

  InterfaceDescription
IItemConfigurationBuilder
Interface must be implemented by ItemConfigurationBuilders, allows to get modified configuration

Delegates

  DelegateDescription
CheckinCompletedEventHandler
Checkin operation was completed handler
CheckinProgressChangedEventHandler
Checkin operation progress has changed handler
DownloadFileCompletedEventHandler
Delegate for DownloadFileCompleted event handler which is called when download of a single file is complete.
DownloadFilesCompletedEventHandler
Delegate for DownloadFilesCompleted event handler which is called when either all files finished downloading or when the operation was canceled by user.
DownloadFilesProgressChangedEventHandler
Delegate for DownloadFilesProgressChanged event handler which is called when download progress is changed.
UploadFileCompletedEventHandler
Uploading of file was completed handler
UploadFilesCompletedEventHandler
Uploading files operation was completed
UploadFilesProgressChangedHandler
Uploading files progress has changed handler

Enumerations

  EnumerationDescription
CheckinManagerFlags
Enumeration for setting additional actions after checkin
CheckoutManagerFlags
Enumeration for setting additional checkout parameters