Files
open class Files
Datatypes and serializers for the files namespace
-
The AddTagArg struct
See moreDeclaration
Swift
open class AddTagArg : CustomStringConvertible
-
The BaseTagError union
See moreDeclaration
Swift
public enum BaseTagError : CustomStringConvertible
-
The AddTagError union
See moreDeclaration
Swift
public enum AddTagError : CustomStringConvertible
-
The GetMetadataArg struct
See moreDeclaration
Swift
open class GetMetadataArg : CustomStringConvertible
-
The AlphaGetMetadataArg struct
See moreDeclaration
Swift
open class AlphaGetMetadataArg : Files.GetMetadataArg
-
The GetMetadataError union
See moreDeclaration
Swift
public enum GetMetadataError : CustomStringConvertible
-
The AlphaGetMetadataError union
See moreDeclaration
Swift
public enum AlphaGetMetadataError : CustomStringConvertible
-
The CommitInfo struct
See moreDeclaration
Swift
open class CommitInfo : CustomStringConvertible
-
The CommitInfoWithProperties struct
Declaration
Swift
open class CommitInfoWithProperties : Files.CommitInfo
-
The ContentSyncSetting struct
See moreDeclaration
Swift
open class ContentSyncSetting : CustomStringConvertible
-
The ContentSyncSettingArg struct
See moreDeclaration
Swift
open class ContentSyncSettingArg : CustomStringConvertible
-
The CreateFolderArg struct
See moreDeclaration
Swift
open class CreateFolderArg : CustomStringConvertible
-
The CreateFolderBatchArg struct
See moreDeclaration
Swift
open class CreateFolderBatchArg : CustomStringConvertible
-
The CreateFolderBatchError union
See moreDeclaration
Swift
public enum CreateFolderBatchError : CustomStringConvertible
-
The CreateFolderBatchJobStatus union
See moreDeclaration
Swift
public enum CreateFolderBatchJobStatus : CustomStringConvertible
-
Result returned by createFolderBatch that may either launch an asynchronous job or complete synchronously.
See moreDeclaration
Swift
public enum CreateFolderBatchLaunch : CustomStringConvertible
-
The FileOpsResult struct
See moreDeclaration
Swift
open class FileOpsResult : CustomStringConvertible
-
The CreateFolderBatchResult struct
See moreDeclaration
Swift
open class CreateFolderBatchResult : Files.FileOpsResult
-
The CreateFolderBatchResultEntry union
See moreDeclaration
Swift
public enum CreateFolderBatchResultEntry : CustomStringConvertible
-
The CreateFolderEntryError union
See moreDeclaration
Swift
public enum CreateFolderEntryError : CustomStringConvertible
-
The CreateFolderEntryResult struct
See moreDeclaration
Swift
open class CreateFolderEntryResult : CustomStringConvertible
-
The CreateFolderError union
See moreDeclaration
Swift
public enum CreateFolderError : CustomStringConvertible
-
The CreateFolderResult struct
See moreDeclaration
Swift
open class CreateFolderResult : Files.FileOpsResult
-
The DeleteArg struct
See moreDeclaration
Swift
open class DeleteArg : CustomStringConvertible
-
The DeleteBatchArg struct
See moreDeclaration
Swift
open class DeleteBatchArg : CustomStringConvertible
-
The DeleteBatchError union
See moreDeclaration
Swift
public enum DeleteBatchError : CustomStringConvertible
-
The DeleteBatchJobStatus union
See moreDeclaration
Swift
public enum DeleteBatchJobStatus : CustomStringConvertible
-
Result returned by deleteBatch that may either launch an asynchronous job or complete synchronously.
See moreDeclaration
Swift
public enum DeleteBatchLaunch : CustomStringConvertible
-
The DeleteBatchResult struct
See moreDeclaration
Swift
open class DeleteBatchResult : Files.FileOpsResult
-
The DeleteBatchResultData struct
See moreDeclaration
Swift
open class DeleteBatchResultData : CustomStringConvertible
-
The DeleteBatchResultEntry union
See moreDeclaration
Swift
public enum DeleteBatchResultEntry : CustomStringConvertible
-
The DeleteError union
See moreDeclaration
Swift
public enum DeleteError : CustomStringConvertible
-
The DeleteResult struct
See moreDeclaration
Swift
open class DeleteResult : Files.FileOpsResult
-
Metadata for a file or folder.
See moreDeclaration
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 moreDeclaration
Swift
open class Dimensions : CustomStringConvertible
-
The DownloadArg struct
See moreDeclaration
Swift
open class DownloadArg : CustomStringConvertible
-
The DownloadError union
See moreDeclaration
Swift
public enum DownloadError : CustomStringConvertible
-
The DownloadZipArg struct
See moreDeclaration
Swift
open class DownloadZipArg : CustomStringConvertible
-
The DownloadZipError union
See moreDeclaration
Swift
public enum DownloadZipError : CustomStringConvertible
-
The DownloadZipResult struct
See moreDeclaration
Swift
open class DownloadZipResult : CustomStringConvertible
-
The ExportArg struct
See moreDeclaration
Swift
open class ExportArg : CustomStringConvertible
-
The ExportError union
See moreDeclaration
Swift
public enum ExportError : CustomStringConvertible
-
Export information for a file.
See moreDeclaration
Swift
open class ExportInfo : CustomStringConvertible
-
The ExportMetadata struct
See moreDeclaration
Swift
open class ExportMetadata : CustomStringConvertible
-
The ExportResult struct
See moreDeclaration
Swift
open class ExportResult : CustomStringConvertible
-
The FileCategory union
See moreDeclaration
Swift
public enum FileCategory : CustomStringConvertible
-
The FileLock struct
See moreDeclaration
Swift
open class FileLock : CustomStringConvertible
-
The FileLockContent union
See moreDeclaration
Swift
public enum FileLockContent : CustomStringConvertible
-
The FileLockMetadata struct
See moreDeclaration
Swift
open class FileLockMetadata : CustomStringConvertible
-
Sharing info for a file or folder.
See moreDeclaration
Swift
open class SharingInfo : CustomStringConvertible
-
Sharing info for a file which is contained by a shared folder.
See moreDeclaration
Swift
open class FileSharingInfo : Files.SharingInfo
-
The FileStatus union
See moreDeclaration
Swift
public enum FileStatus : CustomStringConvertible
-
Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.
See moreDeclaration
Swift
open class FolderSharingInfo : Files.SharingInfo
-
The GetCopyReferenceArg struct
See moreDeclaration
Swift
open class GetCopyReferenceArg : CustomStringConvertible
-
The GetCopyReferenceError union
See moreDeclaration
Swift
public enum GetCopyReferenceError : CustomStringConvertible
-
The GetCopyReferenceResult struct
See moreDeclaration
Swift
open class GetCopyReferenceResult : CustomStringConvertible
-
The GetTagsArg struct
See moreDeclaration
Swift
open class GetTagsArg : CustomStringConvertible
-
The GetTagsResult struct
See moreDeclaration
Swift
open class GetTagsResult : CustomStringConvertible
-
The GetTemporaryLinkArg struct
See moreDeclaration
Swift
open class GetTemporaryLinkArg : CustomStringConvertible
-
The GetTemporaryLinkError union
See moreDeclaration
Swift
public enum GetTemporaryLinkError : CustomStringConvertible
-
The GetTemporaryLinkResult struct
See moreDeclaration
Swift
open class GetTemporaryLinkResult : CustomStringConvertible
-
The GetTemporaryUploadLinkArg struct
See moreDeclaration
Swift
open class GetTemporaryUploadLinkArg : CustomStringConvertible
-
The GetTemporaryUploadLinkResult struct
See moreDeclaration
Swift
open class GetTemporaryUploadLinkResult : CustomStringConvertible
-
Arguments for getThumbnailBatch.
See moreDeclaration
Swift
open class GetThumbnailBatchArg : CustomStringConvertible
-
The GetThumbnailBatchError union
See moreDeclaration
Swift
public enum GetThumbnailBatchError : CustomStringConvertible
-
The GetThumbnailBatchResult struct
See moreDeclaration
Swift
open class GetThumbnailBatchResult : CustomStringConvertible
-
The GetThumbnailBatchResultData struct
See moreDeclaration
Swift
open class GetThumbnailBatchResultData : CustomStringConvertible
-
The GetThumbnailBatchResultEntry union
See moreDeclaration
Swift
public enum GetThumbnailBatchResultEntry : CustomStringConvertible
-
GPS coordinates for a photo or video.
See moreDeclaration
Swift
open class GpsCoordinates : CustomStringConvertible
-
The HighlightSpan struct
See moreDeclaration
Swift
open class HighlightSpan : CustomStringConvertible
-
The import format of the incoming Paper doc content.
See moreDeclaration
Swift
public enum ImportFormat : CustomStringConvertible
-
The ListFolderArg struct
See moreDeclaration
Swift
open class ListFolderArg : CustomStringConvertible
-
The ListFolderContinueArg struct
See moreDeclaration
Swift
open class ListFolderContinueArg : CustomStringConvertible
-
The ListFolderContinueError union
See moreDeclaration
Swift
public enum ListFolderContinueError : CustomStringConvertible
-
The ListFolderError union
See moreDeclaration
Swift
public enum ListFolderError : CustomStringConvertible
-
The ListFolderGetLatestCursorResult struct
See moreDeclaration
Swift
open class ListFolderGetLatestCursorResult : CustomStringConvertible
-
The ListFolderLongpollArg struct
See moreDeclaration
Swift
open class ListFolderLongpollArg : CustomStringConvertible
-
The ListFolderLongpollError union
See moreDeclaration
Swift
public enum ListFolderLongpollError : CustomStringConvertible
-
The ListFolderLongpollResult struct
See moreDeclaration
Swift
open class ListFolderLongpollResult : CustomStringConvertible
-
The ListFolderResult struct
See moreDeclaration
Swift
open class ListFolderResult : CustomStringConvertible
-
The ListRevisionsArg struct
See moreDeclaration
Swift
open class ListRevisionsArg : CustomStringConvertible
-
The ListRevisionsError union
See moreDeclaration
Swift
public enum ListRevisionsError : CustomStringConvertible
-
The ListRevisionsMode union
See moreDeclaration
Swift
public enum ListRevisionsMode : CustomStringConvertible
-
The ListRevisionsResult struct
See moreDeclaration
Swift
open class ListRevisionsResult : CustomStringConvertible
-
The LockConflictError struct
See moreDeclaration
Swift
open class LockConflictError : CustomStringConvertible
-
The LockFileArg struct
See moreDeclaration
Swift
open class LockFileArg : CustomStringConvertible
-
The LockFileBatchArg struct
See moreDeclaration
Swift
open class LockFileBatchArg : CustomStringConvertible
-
The LockFileBatchResult struct
See moreDeclaration
Swift
open class LockFileBatchResult : Files.FileOpsResult
-
The LockFileError union
See moreDeclaration
Swift
public enum LockFileError : CustomStringConvertible
-
The LockFileResult struct
See moreDeclaration
Swift
open class LockFileResult : CustomStringConvertible
-
The LockFileResultEntry union
See moreDeclaration
Swift
public enum LockFileResultEntry : CustomStringConvertible
-
The LookupError union
See moreDeclaration
Swift
public enum LookupError : CustomStringConvertible
-
The MediaInfo union
See moreDeclaration
Swift
public enum MediaInfo : CustomStringConvertible
-
Metadata for a photo or video.
See moreDeclaration
Swift
open class MediaMetadata : CustomStringConvertible
-
Metadata for a file, folder or other resource types.
See moreDeclaration
Swift
public enum MetadataV2 : CustomStringConvertible
-
The MinimalFileLinkMetadata struct
See moreDeclaration
Swift
open class MinimalFileLinkMetadata : CustomStringConvertible
-
The RelocationBatchArgBase struct
See moreDeclaration
Swift
open class RelocationBatchArgBase : CustomStringConvertible
-
The MoveBatchArg struct
See moreDeclaration
Swift
open class MoveBatchArg : Files.RelocationBatchArgBase
-
The MoveIntoVaultError union
See moreDeclaration
Swift
public enum MoveIntoVaultError : CustomStringConvertible
-
The PaperContentError union
See moreDeclaration
Swift
public enum PaperContentError : CustomStringConvertible
-
The PaperCreateArg struct
See moreDeclaration
Swift
open class PaperCreateArg : CustomStringConvertible
-
The PaperCreateError union
See moreDeclaration
Swift
public enum PaperCreateError : CustomStringConvertible
-
The PaperCreateResult struct
See moreDeclaration
Swift
open class PaperCreateResult : CustomStringConvertible
-
The PaperDocUpdatePolicy union
See moreDeclaration
Swift
public enum PaperDocUpdatePolicy : CustomStringConvertible
-
The PaperUpdateArg struct
See moreDeclaration
Swift
open class PaperUpdateArg : CustomStringConvertible
-
The PaperUpdateError union
See moreDeclaration
Swift
public enum PaperUpdateError : CustomStringConvertible
-
The PaperUpdateResult struct
See moreDeclaration
Swift
open class PaperUpdateResult : CustomStringConvertible
-
The PathOrLink union
See moreDeclaration
Swift
public enum PathOrLink : CustomStringConvertible
-
The PathToTags struct
See moreDeclaration
Swift
open class PathToTags : CustomStringConvertible
-
Metadata for a photo.
Declaration
Swift
open class PhotoMetadata : Files.MediaMetadata
-
The PreviewArg struct
See moreDeclaration
Swift
open class PreviewArg : CustomStringConvertible
-
The PreviewError union
See moreDeclaration
Swift
public enum PreviewError : CustomStringConvertible
-
The PreviewResult struct
See moreDeclaration
Swift
open class PreviewResult : CustomStringConvertible
-
The RelocationPath struct
See moreDeclaration
Swift
open class RelocationPath : CustomStringConvertible
-
The RelocationArg struct
See moreDeclaration
Swift
open class RelocationArg : Files.RelocationPath
-
The RelocationBatchArg struct
See moreDeclaration
Swift
open class RelocationBatchArg : RelocationBatchArgBase
-
The RelocationError union
See moreDeclaration
Swift
public enum RelocationError : CustomStringConvertible
-
The RelocationBatchError union
See moreDeclaration
Swift
public enum RelocationBatchError : CustomStringConvertible
-
The RelocationBatchErrorEntry union
See moreDeclaration
Swift
public enum RelocationBatchErrorEntry : CustomStringConvertible
-
The RelocationBatchJobStatus union
See moreDeclaration
Swift
public enum RelocationBatchJobStatus : CustomStringConvertible
-
Result returned by copyBatch or moveBatch that may either launch an asynchronous job or complete synchronously.
See moreDeclaration
Swift
public enum RelocationBatchLaunch : CustomStringConvertible
-
The RelocationBatchResult struct
See moreDeclaration
Swift
open class RelocationBatchResult : Files.FileOpsResult
-
The RelocationBatchResultData struct
See moreDeclaration
Swift
open class RelocationBatchResultData : CustomStringConvertible
-
The RelocationBatchResultEntry union
See moreDeclaration
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 moreDeclaration
Swift
public enum RelocationBatchV2JobStatus : CustomStringConvertible
-
Result returned by copyBatchV2 or moveBatchV2 that may either launch an asynchronous job or complete synchronously.
See moreDeclaration
Swift
public enum RelocationBatchV2Launch : CustomStringConvertible
-
The RelocationBatchV2Result struct
See moreDeclaration
Swift
open class RelocationBatchV2Result : Files.FileOpsResult
-
The RelocationResult struct
See moreDeclaration
Swift
open class RelocationResult : Files.FileOpsResult
-
The RemoveTagArg struct
See moreDeclaration
Swift
open class RemoveTagArg : CustomStringConvertible
-
The RemoveTagError union
See moreDeclaration
Swift
public enum RemoveTagError : CustomStringConvertible
-
The RestoreArg struct
See moreDeclaration
Swift
open class RestoreArg : CustomStringConvertible
-
The RestoreError union
See moreDeclaration
Swift
public enum RestoreError : CustomStringConvertible
-
The SaveCopyReferenceArg struct
See moreDeclaration
Swift
open class SaveCopyReferenceArg : CustomStringConvertible
-
The SaveCopyReferenceError union
See moreDeclaration
Swift
public enum SaveCopyReferenceError : CustomStringConvertible
-
The SaveCopyReferenceResult struct
See moreDeclaration
Swift
open class SaveCopyReferenceResult : CustomStringConvertible
-
The SaveUrlArg struct
See moreDeclaration
Swift
open class SaveUrlArg : CustomStringConvertible
-
The SaveUrlError union
See moreDeclaration
Swift
public enum SaveUrlError : CustomStringConvertible
-
The SaveUrlJobStatus union
See moreDeclaration
Swift
public enum SaveUrlJobStatus : CustomStringConvertible
-
The SaveUrlResult union
See moreDeclaration
Swift
public enum SaveUrlResult : CustomStringConvertible
-
The SearchArg struct
See moreDeclaration
Swift
open class SearchArg : CustomStringConvertible
-
The SearchError union
See moreDeclaration
Swift
public enum SearchError : CustomStringConvertible
-
The SearchMatch struct
See moreDeclaration
Swift
open class SearchMatch : CustomStringConvertible
-
The SearchMatchFieldOptions struct
See moreDeclaration
Swift
open class SearchMatchFieldOptions : CustomStringConvertible
-
Indicates what type of match was found for a given item.
See moreDeclaration
Swift
public enum SearchMatchType : CustomStringConvertible
-
Indicates what type of match was found for a given item.
See moreDeclaration
Swift
public enum SearchMatchTypeV2 : CustomStringConvertible
-
The SearchMatchV2 struct
See moreDeclaration
Swift
open class SearchMatchV2 : CustomStringConvertible
-
The SearchMode union
See moreDeclaration
Swift
public enum SearchMode : CustomStringConvertible
-
The SearchOptions struct
See moreDeclaration
Swift
open class SearchOptions : CustomStringConvertible
-
The SearchOrderBy union
See moreDeclaration
Swift
public enum SearchOrderBy : CustomStringConvertible
-
The SearchResult struct
See moreDeclaration
Swift
open class SearchResult : CustomStringConvertible
-
The SearchV2Arg struct
See moreDeclaration
Swift
open class SearchV2Arg : CustomStringConvertible
-
The SearchV2ContinueArg struct
See moreDeclaration
Swift
open class SearchV2ContinueArg : CustomStringConvertible
-
The SearchV2Result struct
See moreDeclaration
Swift
open class SearchV2Result : CustomStringConvertible
-
The SharedLink struct
See moreDeclaration
Swift
open class SharedLink : CustomStringConvertible
-
The SharedLinkFileInfo struct
See moreDeclaration
Swift
open class SharedLinkFileInfo : CustomStringConvertible
-
The SingleUserLock struct
See moreDeclaration
Swift
open class SingleUserLock : CustomStringConvertible
-
The SymlinkInfo struct
See moreDeclaration
Swift
open class SymlinkInfo : CustomStringConvertible
-
The SyncSetting union
See moreDeclaration
Swift
public enum SyncSetting : CustomStringConvertible
-
The SyncSettingArg union
See moreDeclaration
Swift
public enum SyncSettingArg : CustomStringConvertible
-
The SyncSettingsError union
See moreDeclaration
Swift
public enum SyncSettingsError : CustomStringConvertible
-
Tag that can be added in multiple ways.
See moreDeclaration
Swift
public enum Tag : CustomStringConvertible
-
The ThumbnailArg struct
See moreDeclaration
Swift
open class ThumbnailArg : CustomStringConvertible
-
The ThumbnailError union
See moreDeclaration
Swift
public enum ThumbnailError : CustomStringConvertible
-
The ThumbnailFormat union
See moreDeclaration
Swift
public enum ThumbnailFormat : CustomStringConvertible
-
The ThumbnailMode union
See moreDeclaration
Swift
public enum ThumbnailMode : CustomStringConvertible
-
The ThumbnailSize union
See moreDeclaration
Swift
public enum ThumbnailSize : CustomStringConvertible
-
The ThumbnailV2Arg struct
See moreDeclaration
Swift
open class ThumbnailV2Arg : CustomStringConvertible
-
The ThumbnailV2Error union
See moreDeclaration
Swift
public enum ThumbnailV2Error : CustomStringConvertible
-
The UnlockFileArg struct
See moreDeclaration
Swift
open class UnlockFileArg : CustomStringConvertible
-
The UnlockFileBatchArg struct
See moreDeclaration
Swift
open class UnlockFileBatchArg : CustomStringConvertible
-
The UploadError union
See moreDeclaration
Swift
public enum UploadError : CustomStringConvertible
-
The UploadErrorWithProperties union
See moreDeclaration
Swift
public enum UploadErrorWithProperties : CustomStringConvertible
-
The UploadSessionAppendArg struct
See moreDeclaration
Swift
open class UploadSessionAppendArg : CustomStringConvertible
-
The UploadSessionCursor struct
See moreDeclaration
Swift
open class UploadSessionCursor : CustomStringConvertible
-
The UploadSessionFinishArg struct
See moreDeclaration
Swift
open class UploadSessionFinishArg : CustomStringConvertible
-
The UploadSessionFinishBatchArg struct
See moreDeclaration
Swift
open class UploadSessionFinishBatchArg : CustomStringConvertible
-
The UploadSessionFinishBatchJobStatus union
See moreDeclaration
Swift
public enum UploadSessionFinishBatchJobStatus : CustomStringConvertible
-
Result returned by uploadSessionFinishBatch that may either launch an asynchronous job or complete synchronously.
See moreDeclaration
Swift
public enum UploadSessionFinishBatchLaunch : CustomStringConvertible
-
The UploadSessionFinishBatchResult struct
See moreDeclaration
Swift
open class UploadSessionFinishBatchResult : CustomStringConvertible
-
The UploadSessionFinishBatchResultEntry union
See moreDeclaration
Swift
public enum UploadSessionFinishBatchResultEntry : CustomStringConvertible
-
The UploadSessionFinishError union
See moreDeclaration
Swift
public enum UploadSessionFinishError : CustomStringConvertible
-
The UploadSessionLookupError union
See moreDeclaration
Swift
public enum UploadSessionLookupError : CustomStringConvertible
-
The UploadSessionOffsetError struct
See moreDeclaration
Swift
open class UploadSessionOffsetError : CustomStringConvertible
-
The UploadSessionStartArg struct
See moreDeclaration
Swift
open class UploadSessionStartArg : CustomStringConvertible
-
The UploadSessionStartError union
See moreDeclaration
Swift
public enum UploadSessionStartError : CustomStringConvertible
-
The UploadSessionStartResult struct
See moreDeclaration
Swift
open class UploadSessionStartResult : CustomStringConvertible
-
The UploadSessionType union
See moreDeclaration
Swift
public enum UploadSessionType : CustomStringConvertible
-
The UploadWriteFailed struct
See moreDeclaration
Swift
open class UploadWriteFailed : CustomStringConvertible
-
The UserGeneratedTag struct
See moreDeclaration
Swift
open class UserGeneratedTag : CustomStringConvertible
-
Metadata for a video.
See moreDeclaration
Swift
open class VideoMetadata : Files.MediaMetadata
-
The WriteConflictError union
See moreDeclaration
Swift
public enum WriteConflictError : CustomStringConvertible
-
The WriteError union
See moreDeclaration
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 moreDeclaration
Swift
public enum WriteMode : CustomStringConvertible