Skip to content
CCS Files Docs
Search
Ctrl
K
Cancel
Notifications docs
Chat docs
Identity Server docs
Select theme
Dark
Light
Auto
Menu
Before you start
The Identity Server comes first
Prerequisite checklist
Identity Server docs ↗
Get started
Choose where to start
Backend quickstart: media on a post
Web quickstart: uploads and previews in the browser
Flutter quickstart: uploads from a mobile app
User tokens: the token route
What to store in your database
Concepts
Contexts and tokens
Folders and files
Application-managed folders
Versions
Uploads
Delivery and visibility
Permissions
Processing
Malware scanning
Previews and renditions
Search
Searching inside documents
Share links
Quota and retention
Legal hold
Where files are stored
Events
Media in Chat
Guides
Your backend
Uploading on behalf of users
Feeds and batch URL minting
Permissions from code
Approvals
Search from your backend
Webhooks
Other languages
Local development
Troubleshooting
Administration
The Files console
Browse and upload
File details
Search, trash and share links
Permissions page
Settings page
Usage and audit
Platform administration
Storage accounts
Reference
API conventions
API operations
Overview
Context
Overview
Who the caller is
The caller's tenants
The applications the caller may use
The caller's capabilities here
Folders
Overview
The root folder
Folders by your reference
Create a folder
A folder
Move a folder to the trash
Rename, move or update a folder
List a folder
Breadcrumbs
Bytes, files and folders below
Copy a subtree
Restore a folder from the trash
Release a folder from its application's management
The folder's access entries
Replace the folder's entries or change inheritance
Grant an entry
Revoke an entry
The folder's share links
Create a share link for the folder
The folder's audit trail
A job
Uploads
Overview
Create an upload ticket
A ticket and the parts the store holds
Abort a ticket
More part URLs
Complete an upload
Files
Overview
Mint URLs for many files
Mint URLs for many files
What a user may do with many files
What a user may do with many files
Files by your reference
Files by your reference
A file
A file
Move a file to the trash
Move a file to the trash
Change metadata, status, visibility, folder or owner
Change metadata, status, visibility, folder or owner
Copy a file
Copy a file
Restore a file from the trash
Restore a file from the trash
Delete a file for good
Delete a file for good
A signed download URL
A signed download URL
Redirect to the signed URL
Redirect to the signed URL
What a viewer needs
What a viewer needs
The file's versions
A ticket for a new version
One version
Delete a version
Pin a version or change its comment
Restore an old version
The current version's renditions
The current version's renditions
Produce the renditions again
Produce the renditions again
What a user may do with the file
What a user may do with the file
What the caller may do with the file
What the caller may do with the file
The file's access entries
The file's access entries
Replace the file's entries or change inheritance
Replace the file's entries or change inheritance
Grant an entry on the file
Grant an entry on the file
Revoke an entry on the file
Revoke an entry on the file
The file's share links
The file's share links
Create a share link for the file
Create a share link for the file
The file's audit trail
The file's audit trail
Check out a file (planned)
Check out a file (planned)
Discard a check-out (planned)
Discard a check-out (planned)
Check in a file (planned)
Check in a file (planned)
Open the file in an editor (planned)
Open the file in an editor (planned)
Files under a legal hold
Place a legal hold on a file
Release the legal hold of a file
Versions
Overview
The file's versions
A ticket for a new version
One version
Delete a version
Pin a version or change its comment
Restore an old version
Search
Overview
Search files
Tags in use
A managed value list
Replace a managed value list
Permissions
Overview
Who may do what with files here
Replace a role's permissions here
Who may do what with files, in every application
Replace a tenant role's permissions in every application
The roles an entry may name
The user picker
Shares
Overview
The application's share links
Revoke a share link
What a share link shows
A URL for the shared file
Trash
Overview
What was deleted
Empty the trash
Settings
Overview
What an uploader needs first
The application's settings
Change settings
The application's usage against its quotas
The tenant's usage per application
Every tenant with its usage and quota (platform administrators)
One tenant: usage per application and the tenant settings (platform administrators)
Set a tenant's ceilings (platform administrators)
The platform defaults (platform administrators)
Change the platform defaults (platform administrators)
Usage trends across tenants (platform administrators)
One tenant's usage trend, per application (platform administrators)
Export a tenant's daily usage (platform administrators)
The storage accounts (platform administrators)
Create a storage account (platform administrators)
A storage account (platform administrators)
Remove a storage account (platform administrators)
Change a storage account (platform administrators)
Verify a storage account (platform administrators)
A tenant's storage account and where its objects live (platform administrators)
Assign a tenant to a storage account (platform administrators)
A tenant's storage migrations, newest first (platform administrators)
Move a tenant's objects to another storage account (platform administrators)
A storage migration and its progress (platform administrators)
Audit
Overview
The audit log
Export the audit log
A tenant's audit log across its applications (platform administrators)
Export a tenant's audit log (platform administrators)
Webhooks
Overview
The application's webhook
Set the webhook
The delivery log
Health
Overview
Health check
OpenAPI document
Upload protocol
Errors
Limits
Events
Audit actions
Settings
Renditions and formats
Processing status
Search query
SDKs
SDKs
ccs-files-client (Node, backends)
ccs-files-client
ccs-files-client changelog
API reference
Classes
FilesApiError
FilesClient
FilesConflictError
FilesContextError
FilesForbiddenError
FilesNotFoundError
FilesNotImplementedError
FilesPayloadTooLargeError
FilesPreconditionFailedError
FilesRateLimitedError
FilesUnauthorizedError
FilesUnprocessableError
FilesUploadError
Interfaces
AccessEntry
AccessEntryInput
AuditQuery
AuditRow
Capabilities
CheckinInput
CheckoutInput
ChildrenQuery
CompleteUploadInput
CreatedBy
CreatedShare
CreateFolderInput
CreateShareInput
CreateStorageAccountInput
DailyUsage
DownloadUrl
DownloadUrlOptions
EffectiveEntry
EffectivePermissions
EffectivePermissionsBatch
EntryRole
File
FileHold
FileLock
FileMedia
FilesApiErrorBody
FilesClientOptions
FilesContext
FilesEndpoints
FilesExport
Folder
FolderCopyResult
FolderPath
FolderUsage
HoldsQuery
ItemPermissions
Job
JobAccepted
JobWaitOptions
ManagedBy
Page
PageQuery
PlaceHoldInput
PlatformDefaults
PlatformTenant
PlatformTenantDetail
PlatformTenantsQuery
PlatformTenantTrend
PlatformTenantUsageTrend
PlatformUsageQuery
PlatformUsageTrends
Preview
PublicSettings
ReadableLike
ReleaseHoldInput
Rendition
RenditionInfo
ReplacePermissionsInput
SearchHighlight
SearchQuery
SearchResult
Settings
Share
SharesListQuery
StorageAccount
StorageAccountCredentials
StorageAccountSettings
StorageAccountVerification
StorageMigration
TagsQuery
TagsResult
Taxonomy
TaxonomyInput
TenantAuditExportQuery
TenantAuditQuery
TenantSettings
TenantStorage
TenantTrendPoint
TenantUsage
TrashQuery
UpdateFileInput
UpdateFolderInput
UpdateOptions
UpdateStorageAccountInput
UploadedPart
UploadOptions
UploadPartBatch
UploadPartUrl
UploadPolicy
UploadProgress
UploadRequest
UploadTicket
UrlsOptions
UrlsResult
UrlsResultItem
Usage
UsageExportQuery
UsageExportRow
VerifyWebhookSignatureInput
Version
VersionTicketRequest
WaitUntilReadyOptions
WebhookConfig
WebhookDelivery
WebhookEvent
WebhookInput
Type Aliases
CcsEnvironment
EntryPrincipal
EnvLike
ExportFormat
FileAction
FileInclude
FileKind
FileRecord
FilesEventType
FilesMachineScope
FileState
FileStatus
ItemRef
JobStatus
PlatformDefaultsUpdate
PreviewKind
Principal
Processing
ProcessingStep
ProcessingStepStatus
RenditionName
RenditionStatus
ScanStatus
SearchHit
SettingsUpdate
StorageAdapter
TenantSettingsUpdate
UploadInput
UploadSource
UploadTicketStatus
Visibility
WebhookDeliveryStatus
Variables
FILES_AUDIENCE
FILES_ORIGINS
IDENTITY_ORIGINS
Functions
defaultIssuerUrl
filesEndpoints
isFolderManagedError
toFilesApiError
ccs-files-user-client (web apps)
ccs-files-user-client
ccs-files-user-client changelog
API reference
angular
Interfaces
Files
Functions
createFiles
index
Classes
FilesApiError
FilesClient
FilesConflictError
FilesContextError
FilesForbiddenError
FilesNotFoundError
FilesNotImplementedError
FilesPayloadTooLargeError
FilesPreconditionFailedError
FilesRateLimitedError
FilesUnauthorizedError
FilesUnprocessableError
FilesUploadError
UploadCancelledError
UploadFileMismatchError
Interfaces
AccessEntry
AccessEntryInput
Capabilities
ChildrenQuery
CreatedBy
CreatedShare
CreateFolderInput
CreateShareInput
DownloadOptions
DownloadUrl
DownloadUrlOptions
EntryRole
File
FileHold
FileLock
FilesApiErrorBody
FilesClientOptions
FilesResource
Folder
FolderCopyResult
FolderPath
FoldersResource
GetAccessTokenOptions
HoldResource
HoldsQuery
HoldsResource
ItemPermissions
JobAccepted
ManagedBy
MeResource
MyPermissions
Page
PageQuery
PermissionsResource
PlaceHoldInput
PlaybackSource
Preview
PreviewOptions
PublicSettings
ReleaseHoldInput
ReleaseManagementInput
Rendition
RenditionInfo
RenditionsResource
ReplacePermissionsInput
SearchQuery
SearchResult
SettingsResource
Share
SharesResource
TagsQuery
TagsResult
TicketUploadResult
TokenProvider
TokenProviderOptions
TokenRouteConfig
TrashQuery
TrashResource
UpdateFileInput
UpdateFolderInput
UpdateOptions
UploadedPart
UploadEventMap
UploadFromTicketOptions
UploadHandle
UploadOptions
UploadPartBatch
UploadPartUrl
UploadPolicy
UploadProgress
UploadRequest
UploadSnapshot
UploadsRegistry
UploadTicket
UploadView
UrlsOptions
UrlsResult
UrlsResultItem
Version
VersionsResource
VersionTicketRequest
WaitUntilReadyOptions
XhrLike
Type Aliases
FileAction
FileInclude
FileKind
FileRecord
FileState
FileStatus
FolderRecord
FromTokenRouteOverrides
GetAccessToken
ItemRef
PreviewKind
Principal
Processing
ProcessingStep
ProcessingStepStatus
RenditionName
RenditionStatus
SearchHit
Unsubscribe
UploadInput
UploadState
UploadTarget
UploadTicketStatus
VersionUploadInput
Visibility
Variables
DEFAULT_API_URL
DISPOSED_MESSAGE
Functions
createTokenProvider
isFolderManagedError
isReadOnly
playbackSources
toFilesApiError
toUploadView
react
Interfaces
UseFilesResult
UsePreviewOptions
UsePreviewResult
UseUploadResult
Type Aliases
UseFilesOptions
Functions
useFiles
usePreview
useUpload
ccs_files_user_client (Flutter)
ccs_files_user_client (Flutter)
ccs_files_user_client changelog
Resources
Changelog
What's coming
Glossary
Notifications docs
Chat docs
Identity Server docs
Select theme
Dark
Light
Auto
@central-code-station/ccs-files-user-client
Modules
Section titled “Modules”
angular
index
react