Module file

Module file 

Source
Expand description

Holds all primitives and logic around the file resource.

The file resource is intended to handle user-uploaded files and is the main Uploadcare resource.

Each of uploaded files has an ID (UUID) that is assigned once and never changes later.

Structs§

BatchInfo
Holds batch operation response data
CopyParams
CopyParams is used when copy original files or their modified versions to default storage. Source files MAY either be stored or just uploaded and MUST NOT be deleted
ImageInfo
ImageInfo holds image-specific information
ImageInfoGeoLocation
Image geo location
Info
Info holds file specific information
List
Holds a list of files
ListParams
Holds all possible params for for the list method
LocalCopyInfo
Holds local_copy response data
RemoteCopyInfo
Holds remote_copy response data
Service
Service is used to make calls to file API.
VideoInfo
Video related information
VideoInfoAudio
Information about the audio in video
VideoInfoVideo
Video stream info

Enums§

ColorMode
Image color mode.
MakePublic
MUST be either true or false. true to make copied files available via public links, false to reverse the behavior.
Ordering
Specifies the way files are sorted in a returned list. By default is set to datetime_uploaded.
Pattern
The parameter is used to specify file names Uploadcare passes to a custom storage. In case the parameter is omitted, we use pattern of your custom storage. Use any combination of allowed values.
ToStore
MUST be either true or false

Functions§

new_svc
creates an instance of the file service