Files

open class Files

Datatypes and serializers for the files namespace

  • The GetMetadataArg struct

    See more

    Declaration

    Swift

    open class GetMetadataArg : CustomStringConvertible

  • The AlphaGetMetadataArg struct

    See more

    Declaration

    Swift

    open class AlphaGetMetadataArg : Files.GetMetadataArg

  • The GetMetadataError union

    See more

    Declaration

    Swift

    public enum GetMetadataError : CustomStringConvertible

  • The AlphaGetMetadataError union

    See more

    Declaration

    Swift

    public enum AlphaGetMetadataError : CustomStringConvertible

  • The CommitInfo struct

    See more

    Declaration

    Swift

    open class CommitInfo : CustomStringConvertible

  • The CommitInfoWithProperties struct

    Declaration

    Swift

    open class CommitInfoWithProperties : Files.CommitInfo

  • The ContentSyncSetting struct

    See more

    Declaration

    Swift

    open class ContentSyncSetting : CustomStringConvertible

  • The ContentSyncSettingArg struct

    See more

    Declaration

    Swift

    open class ContentSyncSettingArg : CustomStringConvertible

  • The CreateFolderArg struct

    See more

    Declaration

    Swift

    open class CreateFolderArg : CustomStringConvertible

  • The CreateFolderBatchArg struct

    See more

    Declaration

    Swift

    open class CreateFolderBatchArg : CustomStringConvertible

  • The CreateFolderBatchError union

    See more

    Declaration

    Swift

    public enum CreateFolderBatchError : CustomStringConvertible

  • The CreateFolderBatchJobStatus union

    See more

    Declaration

    Swift

    public enum CreateFolderBatchJobStatus : CustomStringConvertible

  • Result returned by createFolderBatch that may either launch an asynchronous job or complete synchronously.

    See more

    Declaration

    Swift

    public enum CreateFolderBatchLaunch : CustomStringConvertible

  • The FileOpsResult struct

    See more

    Declaration

    Swift

    open class FileOpsResult : CustomStringConvertible

  • The CreateFolderBatchResult struct

    See more

    Declaration

    Swift

    open class CreateFolderBatchResult : Files.FileOpsResult

  • The CreateFolderBatchResultEntry union

    See more

    Declaration

    Swift

    public enum CreateFolderBatchResultEntry : CustomStringConvertible

  • The CreateFolderEntryError union

    See more

    Declaration

    Swift

    public enum CreateFolderEntryError : CustomStringConvertible

  • The CreateFolderEntryResult struct

    See more

    Declaration

    Swift

    open class CreateFolderEntryResult : CustomStringConvertible

  • The CreateFolderError union

    See more

    Declaration

    Swift

    public enum CreateFolderError : CustomStringConvertible

  • The CreateFolderResult struct

    See more

    Declaration

    Swift

    open class CreateFolderResult : Files.FileOpsResult

  • The DeleteArg struct

    See more

    Declaration

    Swift

    open class DeleteArg : CustomStringConvertible

  • The DeleteBatchArg struct

    See more

    Declaration

    Swift

    open class DeleteBatchArg : CustomStringConvertible

  • The DeleteBatchError union

    See more

    Declaration

    Swift

    public enum DeleteBatchError : CustomStringConvertible

  • The DeleteBatchJobStatus union

    See more

    Declaration

    Swift

    public enum DeleteBatchJobStatus : CustomStringConvertible

  • Result returned by deleteBatch that may either launch an asynchronous job or complete synchronously.

    See more

    Declaration

    Swift

    public enum DeleteBatchLaunch : CustomStringConvertible

  • The DeleteBatchResult struct

    See more

    Declaration

    Swift

    open class DeleteBatchResult : Files.FileOpsResult

  • The DeleteBatchResultData struct

    See more

    Declaration

    Swift

    open class DeleteBatchResultData : CustomStringConvertible

  • The DeleteBatchResultEntry union

    See more

    Declaration

    Swift

    public enum DeleteBatchResultEntry : CustomStringConvertible

  • The DeleteError union

    See more

    Declaration

    Swift

    public enum DeleteError : CustomStringConvertible

  • The DeleteResult struct

    See more

    Declaration

    Swift

    open class DeleteResult : Files.FileOpsResult

  • Metadata for a file or folder.

    See more

    Declaration

    Swift

    open class Metadata : CustomStringConvertible

  • Indicates that there used to be a file or folder at this path, but it no longer exists.

    Declaration

    Swift

    open class DeletedMetadata : Files.Metadata

  • Dimensions for a photo or video.

    See more

    Declaration

    Swift

    open class Dimensions : CustomStringConvertible

  • The DownloadArg struct

    See more

    Declaration

    Swift

    open class DownloadArg : CustomStringConvertible

  • The DownloadError union

    See more

    Declaration

    Swift

    public enum DownloadError : CustomStringConvertible

  • The DownloadZipArg struct

    See more

    Declaration

    Swift

    open class DownloadZipArg : CustomStringConvertible

  • The DownloadZipError union

    See more

    Declaration

    Swift

    public enum DownloadZipError : CustomStringConvertible

  • The DownloadZipResult struct

    See more

    Declaration

    Swift

    open class DownloadZipResult : CustomStringConvertible

  • The ExportArg struct

    See more

    Declaration

    Swift

    open class ExportArg : CustomStringConvertible

  • The ExportError union

    See more

    Declaration

    Swift

    public enum ExportError : CustomStringConvertible

  • Export information for a file.

    See more

    Declaration

    Swift

    open class ExportInfo : CustomStringConvertible

  • The ExportMetadata struct

    See more

    Declaration

    Swift

    open class ExportMetadata : CustomStringConvertible

  • The ExportResult struct

    See more

    Declaration

    Swift

    open class ExportResult : CustomStringConvertible

  • The FileCategory union

    See more

    Declaration

    Swift

    public enum FileCategory : CustomStringConvertible

  • The FileLock struct

    See more

    Declaration

    Swift

    open class FileLock : CustomStringConvertible

  • The FileLockContent union

    See more

    Declaration

    Swift

    public enum FileLockContent : CustomStringConvertible

  • The FileLockMetadata struct

    See more

    Declaration

    Swift

    open class FileLockMetadata : CustomStringConvertible

  • The FileMetadata struct

    See more

    Declaration

    Swift

    open class FileMetadata : Files.Metadata

  • Sharing info for a file or folder.

    See more

    Declaration

    Swift

    open class SharingInfo : CustomStringConvertible

  • Sharing info for a file which is contained by a shared folder.

    See more

    Declaration

    Swift

    open class FileSharingInfo : Files.SharingInfo

  • The FileStatus union

    See more

    Declaration

    Swift

    public enum FileStatus : CustomStringConvertible

  • The FolderMetadata struct

    See more

    Declaration

    Swift

    open class FolderMetadata : Files.Metadata

  • Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

    See more

    Declaration

    Swift

    open class FolderSharingInfo : Files.SharingInfo

  • The GetCopyReferenceArg struct

    See more

    Declaration

    Swift

    open class GetCopyReferenceArg : CustomStringConvertible

  • The GetCopyReferenceError union

    See more

    Declaration

    Swift

    public enum GetCopyReferenceError : CustomStringConvertible

  • The GetCopyReferenceResult struct

    See more

    Declaration

    Swift

    open class GetCopyReferenceResult : CustomStringConvertible

  • The GetTemporaryLinkArg struct

    See more

    Declaration

    Swift

    open class GetTemporaryLinkArg : CustomStringConvertible

  • The GetTemporaryLinkError union

    See more

    Declaration

    Swift

    public enum GetTemporaryLinkError : CustomStringConvertible

  • The GetTemporaryLinkResult struct

    See more

    Declaration

    Swift

    open class GetTemporaryLinkResult : CustomStringConvertible

  • The GetTemporaryUploadLinkArg struct

    See more

    Declaration

    Swift

    open class GetTemporaryUploadLinkArg : CustomStringConvertible

  • The GetTemporaryUploadLinkResult struct

    See more

    Declaration

    Swift

    open class GetTemporaryUploadLinkResult : CustomStringConvertible

  • Arguments for getThumbnailBatch.

    See more

    Declaration

    Swift

    open class GetThumbnailBatchArg : CustomStringConvertible

  • The GetThumbnailBatchError union

    See more

    Declaration

    Swift

    public enum GetThumbnailBatchError : CustomStringConvertible

  • The GetThumbnailBatchResult struct

    See more

    Declaration

    Swift

    open class GetThumbnailBatchResult : CustomStringConvertible

  • The GetThumbnailBatchResultData struct

    See more

    Declaration

    Swift

    open class GetThumbnailBatchResultData : CustomStringConvertible

  • The GetThumbnailBatchResultEntry union

    See more

    Declaration

    Swift

    public enum GetThumbnailBatchResultEntry : CustomStringConvertible

  • GPS coordinates for a photo or video.

    See more

    Declaration

    Swift

    open class GpsCoordinates : CustomStringConvertible

  • The HighlightSpan struct

    See more

    Declaration

    Swift

    open class HighlightSpan : CustomStringConvertible

  • The import format of the incoming Paper doc content.

    See more

    Declaration

    Swift

    public enum ImportFormat : CustomStringConvertible

  • The ListFolderArg struct

    See more

    Declaration

    Swift

    open class ListFolderArg : CustomStringConvertible

  • The ListFolderContinueArg struct

    See more

    Declaration

    Swift

    open class ListFolderContinueArg : CustomStringConvertible

  • The ListFolderContinueError union

    See more

    Declaration

    Swift

    public enum ListFolderContinueError : CustomStringConvertible

  • The ListFolderError union

    See more

    Declaration

    Swift

    public enum ListFolderError : CustomStringConvertible

  • The ListFolderGetLatestCursorResult struct

    See more

    Declaration

    Swift

    open class ListFolderGetLatestCursorResult : CustomStringConvertible

  • The ListFolderLongpollArg struct

    See more

    Declaration

    Swift

    open class ListFolderLongpollArg : CustomStringConvertible

  • The ListFolderLongpollError union

    See more

    Declaration

    Swift

    public enum ListFolderLongpollError : CustomStringConvertible

  • The ListFolderLongpollResult struct

    See more

    Declaration

    Swift

    open class ListFolderLongpollResult : CustomStringConvertible

  • The ListFolderResult struct

    See more

    Declaration

    Swift

    open class ListFolderResult : CustomStringConvertible

  • The ListRevisionsArg struct

    See more

    Declaration

    Swift

    open class ListRevisionsArg : CustomStringConvertible

  • The ListRevisionsError union

    See more

    Declaration

    Swift

    public enum ListRevisionsError : CustomStringConvertible

  • The ListRevisionsMode union

    See more

    Declaration

    Swift

    public enum ListRevisionsMode : CustomStringConvertible

  • The ListRevisionsResult struct

    See more

    Declaration

    Swift

    open class ListRevisionsResult : CustomStringConvertible

  • The LockConflictError struct

    See more

    Declaration

    Swift

    open class LockConflictError : CustomStringConvertible

  • The LockFileArg struct

    See more

    Declaration

    Swift

    open class LockFileArg : CustomStringConvertible

  • The LockFileBatchArg struct

    See more

    Declaration

    Swift

    open class LockFileBatchArg : CustomStringConvertible

  • The LockFileBatchResult struct

    See more

    Declaration

    Swift

    open class LockFileBatchResult : Files.FileOpsResult

  • The LockFileError union

    See more

    Declaration

    Swift

    public enum LockFileError : CustomStringConvertible

  • The LockFileResult struct

    See more

    Declaration

    Swift

    open class LockFileResult : CustomStringConvertible

  • The LockFileResultEntry union

    See more

    Declaration

    Swift

    public enum LockFileResultEntry : CustomStringConvertible

  • The LookupError union

    See more

    Declaration

    Swift

    public enum LookupError : CustomStringConvertible

  • The MediaInfo union

    See more

    Declaration

    Swift

    public enum MediaInfo : CustomStringConvertible

  • Metadata for a photo or video.

    See more

    Declaration

    Swift

    open class MediaMetadata : CustomStringConvertible

  • Metadata for a file, folder or other resource types.

    See more

    Declaration

    Swift

    public enum MetadataV2 : CustomStringConvertible

  • The MinimalFileLinkMetadata struct

    See more

    Declaration

    Swift

    open class MinimalFileLinkMetadata : CustomStringConvertible

  • The RelocationBatchArgBase struct

    See more

    Declaration

    Swift

    open class RelocationBatchArgBase : CustomStringConvertible

  • The MoveBatchArg struct

    See more

    Declaration

    Swift

    open class MoveBatchArg : Files.RelocationBatchArgBase

  • The MoveIntoVaultError union

    See more

    Declaration

    Swift

    public enum MoveIntoVaultError : CustomStringConvertible

  • The PaperContentError union

    See more

    Declaration

    Swift

    public enum PaperContentError : CustomStringConvertible

  • The PaperCreateArg struct

    See more

    Declaration

    Swift

    open class PaperCreateArg : CustomStringConvertible

  • The PaperCreateError union

    See more

    Declaration

    Swift

    public enum PaperCreateError : CustomStringConvertible

  • The PaperCreateResult struct

    See more

    Declaration

    Swift

    open class PaperCreateResult : CustomStringConvertible

  • The PaperDocUpdatePolicy union

    See more

    Declaration

    Swift

    public enum PaperDocUpdatePolicy : CustomStringConvertible

  • The PaperUpdateArg struct

    See more

    Declaration

    Swift

    open class PaperUpdateArg : CustomStringConvertible

  • The PaperUpdateError union

    See more

    Declaration

    Swift

    public enum PaperUpdateError : CustomStringConvertible

  • The PaperUpdateResult struct

    See more

    Declaration

    Swift

    open class PaperUpdateResult : CustomStringConvertible

  • The PathOrLink union

    See more

    Declaration

    Swift

    public enum PathOrLink : CustomStringConvertible

  • Metadata for a photo.

    Declaration

    Swift

    open class PhotoMetadata : Files.MediaMetadata

  • The PreviewArg struct

    See more

    Declaration

    Swift

    open class PreviewArg : CustomStringConvertible

  • The PreviewError union

    See more

    Declaration

    Swift

    public enum PreviewError : CustomStringConvertible

  • The PreviewResult struct

    See more

    Declaration

    Swift

    open class PreviewResult : CustomStringConvertible

  • The RelocationPath struct

    See more

    Declaration

    Swift

    open class RelocationPath : CustomStringConvertible

  • The RelocationArg struct

    See more

    Declaration

    Swift

    open class RelocationArg : Files.RelocationPath

  • The RelocationBatchArg struct

    See more

    Declaration

    Swift

    open class RelocationBatchArg : RelocationBatchArgBase

  • The RelocationError union

    See more

    Declaration

    Swift

    public enum RelocationError : CustomStringConvertible

  • The RelocationBatchError union

    See more

    Declaration

    Swift

    public enum RelocationBatchError : CustomStringConvertible

  • The RelocationBatchErrorEntry union

    See more

    Declaration

    Swift

    public enum RelocationBatchErrorEntry : CustomStringConvertible

  • The RelocationBatchJobStatus union

    See more

    Declaration

    Swift

    public enum RelocationBatchJobStatus : CustomStringConvertible

  • Result returned by copyBatch or moveBatch that may either launch an asynchronous job or complete synchronously.

    See more

    Declaration

    Swift

    public enum RelocationBatchLaunch : CustomStringConvertible

  • The RelocationBatchResult struct

    See more

    Declaration

    Swift

    open class RelocationBatchResult : Files.FileOpsResult

  • The RelocationBatchResultData struct

    See more

    Declaration

    Swift

    open class RelocationBatchResultData : CustomStringConvertible

  • The RelocationBatchResultEntry union

    See more

    Declaration

    Swift

    public enum RelocationBatchResultEntry : CustomStringConvertible

  • Result returned by copyBatchCheckV2 or moveBatchCheckV2 that may either be in progress or completed with result for each entry.

    See more

    Declaration

    Swift

    public enum RelocationBatchV2JobStatus : CustomStringConvertible

  • Result returned by copyBatchV2 or moveBatchV2 that may either launch an asynchronous job or complete synchronously.

    See more

    Declaration

    Swift

    public enum RelocationBatchV2Launch : CustomStringConvertible

  • The RelocationBatchV2Result struct

    See more

    Declaration

    Swift

    open class RelocationBatchV2Result : Files.FileOpsResult

  • The RelocationResult struct

    See more

    Declaration

    Swift

    open class RelocationResult : Files.FileOpsResult

  • The RestoreArg struct

    See more

    Declaration

    Swift

    open class RestoreArg : CustomStringConvertible

  • The RestoreError union

    See more

    Declaration

    Swift

    public enum RestoreError : CustomStringConvertible

  • The SaveCopyReferenceArg struct

    See more

    Declaration

    Swift

    open class SaveCopyReferenceArg : CustomStringConvertible

  • The SaveCopyReferenceError union

    See more

    Declaration

    Swift

    public enum SaveCopyReferenceError : CustomStringConvertible

  • The SaveCopyReferenceResult struct

    See more

    Declaration

    Swift

    open class SaveCopyReferenceResult : CustomStringConvertible

  • The SaveUrlArg struct

    See more

    Declaration

    Swift

    open class SaveUrlArg : CustomStringConvertible

  • The SaveUrlError union

    See more

    Declaration

    Swift

    public enum SaveUrlError : CustomStringConvertible

  • The SaveUrlJobStatus union

    See more

    Declaration

    Swift

    public enum SaveUrlJobStatus : CustomStringConvertible

  • The SaveUrlResult union

    See more

    Declaration

    Swift

    public enum SaveUrlResult : CustomStringConvertible

  • The SearchArg struct

    See more

    Declaration

    Swift

    open class SearchArg : CustomStringConvertible

  • The SearchError union

    See more

    Declaration

    Swift

    public enum SearchError : CustomStringConvertible

  • The SearchMatch struct

    See more

    Declaration

    Swift

    open class SearchMatch : CustomStringConvertible

  • The SearchMatchFieldOptions struct

    See more

    Declaration

    Swift

    open class SearchMatchFieldOptions : CustomStringConvertible

  • Indicates what type of match was found for a given item.

    See more

    Declaration

    Swift

    public enum SearchMatchType : CustomStringConvertible

  • Indicates what type of match was found for a given item.

    See more

    Declaration

    Swift

    public enum SearchMatchTypeV2 : CustomStringConvertible

  • The SearchMatchV2 struct

    See more

    Declaration

    Swift

    open class SearchMatchV2 : CustomStringConvertible

  • The SearchMode union

    See more

    Declaration

    Swift

    public enum SearchMode : CustomStringConvertible

  • The SearchOptions struct

    See more

    Declaration

    Swift

    open class SearchOptions : CustomStringConvertible

  • The SearchOrderBy union

    See more

    Declaration

    Swift

    public enum SearchOrderBy : CustomStringConvertible

  • The SearchResult struct

    See more

    Declaration

    Swift

    open class SearchResult : CustomStringConvertible

  • The SearchV2Arg struct

    See more

    Declaration

    Swift

    open class SearchV2Arg : CustomStringConvertible

  • The SearchV2ContinueArg struct

    See more

    Declaration

    Swift

    open class SearchV2ContinueArg : CustomStringConvertible

  • The SearchV2Result struct

    See more

    Declaration

    Swift

    open class SearchV2Result : CustomStringConvertible

  • The SharedLink struct

    See more

    Declaration

    Swift

    open class SharedLink : CustomStringConvertible

  • The SharedLinkFileInfo struct

    See more

    Declaration

    Swift

    open class SharedLinkFileInfo : CustomStringConvertible

  • The SingleUserLock struct

    See more

    Declaration

    Swift

    open class SingleUserLock : CustomStringConvertible

  • The SymlinkInfo struct

    See more

    Declaration

    Swift

    open class SymlinkInfo : CustomStringConvertible

  • The SyncSetting union

    See more

    Declaration

    Swift

    public enum SyncSetting : CustomStringConvertible

  • The SyncSettingArg union

    See more

    Declaration

    Swift

    public enum SyncSettingArg : CustomStringConvertible

  • The SyncSettingsError union

    See more

    Declaration

    Swift

    public enum SyncSettingsError : CustomStringConvertible

  • The ThumbnailArg struct

    See more

    Declaration

    Swift

    open class ThumbnailArg : CustomStringConvertible

  • The ThumbnailError union

    See more

    Declaration

    Swift

    public enum ThumbnailError : CustomStringConvertible

  • The ThumbnailFormat union

    See more

    Declaration

    Swift

    public enum ThumbnailFormat : CustomStringConvertible

  • The ThumbnailMode union

    See more

    Declaration

    Swift

    public enum ThumbnailMode : CustomStringConvertible

  • The ThumbnailSize union

    See more

    Declaration

    Swift

    public enum ThumbnailSize : CustomStringConvertible

  • The ThumbnailV2Arg struct

    See more

    Declaration

    Swift

    open class ThumbnailV2Arg : CustomStringConvertible

  • The ThumbnailV2Error union

    See more

    Declaration

    Swift

    public enum ThumbnailV2Error : CustomStringConvertible

  • The UnlockFileArg struct

    See more

    Declaration

    Swift

    open class UnlockFileArg : CustomStringConvertible

  • The UnlockFileBatchArg struct

    See more

    Declaration

    Swift

    open class UnlockFileBatchArg : CustomStringConvertible

  • The UploadError union

    See more

    Declaration

    Swift

    public enum UploadError : CustomStringConvertible

  • The UploadErrorWithProperties union

    See more

    Declaration

    Swift

    public enum UploadErrorWithProperties : CustomStringConvertible

  • The UploadSessionAppendArg struct

    See more

    Declaration

    Swift

    open class UploadSessionAppendArg : CustomStringConvertible

  • The UploadSessionCursor struct

    See more

    Declaration

    Swift

    open class UploadSessionCursor : CustomStringConvertible

  • The UploadSessionFinishArg struct

    See more

    Declaration

    Swift

    open class UploadSessionFinishArg : CustomStringConvertible

  • The UploadSessionFinishBatchArg struct

    See more

    Declaration

    Swift

    open class UploadSessionFinishBatchArg : CustomStringConvertible

  • The UploadSessionFinishBatchJobStatus union

    See more

    Declaration

    Swift

    public enum UploadSessionFinishBatchJobStatus : CustomStringConvertible

  • Result returned by uploadSessionFinishBatch that may either launch an asynchronous job or complete synchronously.

    See more

    Declaration

    Swift

    public enum UploadSessionFinishBatchLaunch : CustomStringConvertible

  • The UploadSessionFinishBatchResult struct

    See more

    Declaration

    Swift

    open class UploadSessionFinishBatchResult : CustomStringConvertible

  • The UploadSessionFinishBatchResultEntry union

    See more

    Declaration

    Swift

    public enum UploadSessionFinishBatchResultEntry : CustomStringConvertible

  • The UploadSessionFinishError union

    See more

    Declaration

    Swift

    public enum UploadSessionFinishError : CustomStringConvertible

  • The UploadSessionLookupError union

    See more

    Declaration

    Swift

    public enum UploadSessionLookupError : CustomStringConvertible

  • The UploadSessionOffsetError struct

    See more

    Declaration

    Swift

    open class UploadSessionOffsetError : CustomStringConvertible

  • The UploadSessionStartArg struct

    See more

    Declaration

    Swift

    open class UploadSessionStartArg : CustomStringConvertible

  • The UploadSessionStartError union

    See more

    Declaration

    Swift

    public enum UploadSessionStartError : CustomStringConvertible

  • The UploadSessionStartResult struct

    See more

    Declaration

    Swift

    open class UploadSessionStartResult : CustomStringConvertible

  • The UploadSessionType union

    See more

    Declaration

    Swift

    public enum UploadSessionType : CustomStringConvertible

  • The UploadWriteFailed struct

    See more

    Declaration

    Swift

    open class UploadWriteFailed : CustomStringConvertible

  • Metadata for a video.

    See more

    Declaration

    Swift

    open class VideoMetadata : Files.MediaMetadata

  • The WriteConflictError union

    See more

    Declaration

    Swift

    public enum WriteConflictError : CustomStringConvertible

  • The WriteError union

    See more

    Declaration

    Swift

    public enum WriteError : CustomStringConvertible

  • Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is. In some situations, the conflict behavior is identical: (a) If the target path doesn’t refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it’s always a conflict. © If the target path refers to a file with identical contents, nothing gets written; no conflict. The conflict checking differs in the case where there’s a file at the target path with contents different from the contents you’re trying to write.

    See more

    Declaration

    Swift

    public enum WriteMode : CustomStringConvertible