Classes
- UploadService
-
Service used for uploading files.
- Client
-
Represents a client that allows communicating with the Filestack REST API.
- DataResponse
-
This object represents a network data response.
- DownloadResponse
-
This object represents a network download response.
- FileLink
-
Represents a
FileLink
object. - JSONResponse
-
This object represents a network JSON response.
- Policy
-
Represents a policy object.
- Security
-
Represents a security object.
- StorageOptions
-
Represents a set of storage options.
- Transformable
-
Represents an
Transformable
object. - UploadOptions
-
Represents a set of options for uploading items to a given storage location.
- BaseOperation
-
An operation that simplifies state flag handling and provides a method to finish a task delivering a
result
containing either aSuccess
response or anError
response. - ASCIITransform
-
Converts the image to black and white.
- AVTransform
-
Converts a video or audio to a different format, resolution, sample rate, etc.
- AnimateTransform
-
Converts a set of images to a GIF file.
- AutoImageTransform
-
Changes encoding of the image based on the user agent and therefore provides better compression and quality characteristics compared to their older JPEG and PNG counterparts.
- BlackAndWhiteTransform
-
Converts the image to black and white.
- BlurFacesTransform
-
Blur selected faces contained inside an image.
- BlurTransform
-
Applies a blurring effect to the image.
- BorderTransform
-
Applies a border effect to the image.
- CacheTransform
-
Takes the file or files that are passed into it and compresses them into a zip file.
- CircleTransform
-
Applies a circle border effect to the image.
- CollageTransform
-
The collage task accepts an array of Filestack file handles, storage aliases, or external URLs. These files are appended in given order to the base file of the transformation URL. Altogther the base image and the passed files are the images that will comprise the collage. The order in which they are added dictates how the images will be arranged.
- CollageTransformCollection
-
Class that is used for creating and sanitizing collection of file handles, storage aliases, or external urls.
- CompressTransform
-
Utilizes mozjpeg to offer improved compression for JPGS over the algorithm used for
output=compress:true
. It will not attempt to re-compress a previously compressed image. - ConvertTransform
-
Converts the image to a different format.
- CopyrightTransform
-
Detects whether your image is copyright protected or not, and if it is protected, returns all types and related details such as purchase link, etc.
- CropFacesTransform
-
Crops selected faces contained inside an image.
- CropTransform
-
Crops the image to a specified rectangle.
- DetectFacesTransform
-
Detects the faces contained inside an image.
- DocumentDetectionTransform
-
Detects your document in the image, transforms it to fully fit the image, and preprocesses it using de-noising and distortion reduction in order to increase the accuracy of OCR engine in text extraction.
- EnhanceTransform
-
Smartly analyzes a photo and performs color correction and other enhancements to improve the overall quality of the image.
- FallbackTransform
-
Returns default file if the source of the transformation does not work or the transformation fails.
- FlipTransform
-
Flips/mirrors the image vertically.
- FlopTransform
-
Flips/mirrors the image horizontally.
- ImageSizeTransform
-
Returns the width and height of a given image.
- MinifyCSSTransform
-
Minifies your CSS files.
- MinifyJSTransform
-
Minifies your JavaScript files.
- ModulateTransform
-
Changes the image brightness, saturation and hue.
- MonochromeTransform
-
Converts the image to monochrome.
- NegativeTransform
-
Returns a negative image by portraying the lightest area as the darkest and the darkest areas as the lightest.
- NoMetadataTransform
-
Removes any metadata embedded in an image.
- OCRTransform
-
Detects both printed and handwritten texts in images. The result follows the standard JSON format containing all of the details regarding detected text areas, lines, and words.
- OilPaintTransform
-
Change the image to look like it was oil painted.
- PDFConvertTransform
-
Converts a PDF to a specific orientation, page format, and, optionally, extracts specific pages.
- PDFInfoTransform
-
Gets information about a PDF document.
- PDFMonochromeTransform
-
Converts a PDF to black and white version.
- PartialBlurTransform
-
Changes image brightness, saturation and hue.
- PartialPixelateTransform
-
Changes image brightness, saturation and hue.
- PixelateFacesTransform
-
Pixelates selected faces contained inside an image.
- PixelateTransform
-
Pixelates the image.
- PolaroidTransform
-
Applies a Polaroid border effect to the image.
- ProgressiveJPEGTransform
-
Converts an image to progressive JPEG.
- QualityTransform
-
Sets the quality of your JPG or WEBP image without the danger of possibly generating a larger file.
- RedEyeRemovalTransform
-
Removes the red eye effect from photos.
- ResizeTransform
-
Resizes the image to a given width and height using a particular fit and alignment mode.
- RotateTransform
-
Rotates an image in a range from 0 to 359 degrees or based on Exif information.
- RoundedCornersTransform
-
Rounds the image's corners.
- SecureForWorkTransform
-
Returns whether the image if safe to display.
- SepiaTransform
-
Converts the image to sepia color.
- ShadowTransform
-
Applies a shadow border effect to the image.
- SharpenTransform
-
Applies a sharpening effect to the image.
- TagsTransform
-
Analyzes and returns any tags associated to this image.
- TornEdgesTransform
-
Applies a torn edge border effect to the image.
- Transform
-
:nodoc:
- URLScreenshotTransform
-
Captures content of given URL. The URL screenshot task will not work for content that is located in areas that require you to login. If the content is not publicly visible, then it will not be captured.
- UpscaleTransform
-
Upscales the image making it two times bigger.
- VignetteTransform
-
Applies a vignette border effect to the image.
- WatermarkTransform
-
Watermarks the image by overlaying another image on top of your main image.
- ZipTransform
-
Takes the file or files that are passed into it and compresses them into a zip file.
Structures
- MetadataOptions
-
Represents a metadata option.
- PolicyCall
-
Represents a policy call type.
- TransformPosition
-
Represents an image transform position type.
Enumerations
- Error
-
:nodoc:
- StorageAccess
-
Represents the storage access to a file.
- StorageLocation
-
Represents a cloud storage location type.
- TransformAlign
-
Represents an image transform alignment type.
- TransformAspectMode
-
Represents an image transform aspect type.
- TransformBlurMode
-
Represents an image transform blur type.
- TransformColorSpace
-
Represents an image transform color space type.
- TransformCropMode
-
Represents an image transform crop type.
- TransformEnhancePreset
-
Represents an enhance transformation preset.
- TransformFiletype
-
Represents an image transform noise reduction type.
- TransformFit
-
Represents an image transform fit type.
- TransformNoiseMode
-
Represents an image transform noise reduction type.
- TransformPageFormat
-
Represents an image transform page format type.
- TransformPageOrientation
-
Represents an image transform page orientation type.
- TransformShapeType
-
Represents an image transform pixelate faces type.
- TransformStyleMode
-
Represents an image transform style type.
- UploadState
-
Represents the current state of an upload.
Protocols
- Cancellable
-
The protocol any cancellable process must conform to.
- DeferredAdd
-
The protocol any uploader that supports deferred adds must conform to.
- Monitorizable
-
The protocol any monitorizable process must conform to.
- Startable
-
The protocol any startable process must conform to.
- Uploadable
-
The protocol any uploadables must conform to.
- Uploader
-
The protocol any uploader must conform to.
Typealiases
- UploadStatus
- NetworkDataResponse
- NetworkDownloadResponse
- NetworkJSONResponse
Extensions
- Data
- URL