Classes

The following classes are available globally.

  • Service used for uploading files.

    See more

    Declaration

    Swift

    @objc(FSUploadService)
public final class UploadService : NSObject, NetworkingService
    extension UploadService: URLSessionDataDelegate

  • Represents a client that allows communicating with the Filestack REST API.

    See more

    Declaration

    Swift

    @objc(FSClient)
public class Client : NSObject

  • Represents an Transformable object.

    See Image Transformations Overview for more information about image transformations.

    See more

    Declaration

    Swift

    public class Transformable : NSObject

  • This object represents a network data response.

    See more

    Declaration

    Swift

    @objc(FSNetworkDataResponse)
public class DataResponse : NSObject

  • This object represents a network download response.

    See more

    Declaration

    Swift

    @objc(FSNetworkDownloadResponse)
public class DownloadResponse : NSObject

  • Represents a FileLink object.

    See Filestack Architecture Overview for more information about files.

    See more

    Declaration

    Swift

    @objc(FSFileLink)
public class FileLink : NSObject

  • This object represents a network JSON response.

    See more

    Declaration

    Swift

    @objc(FSNetworkJSONResponse)
public class JSONResponse : NSObject

  • Represents a policy object.

    See Creating Policies for more information about policies.

    See more

    Declaration

    Swift

    @objc(FSPolicy)
public class Policy : NSObject

  • Represents a security object.

    See Security Overview for more information about security.

    See more

    Declaration

    Swift

    @objc(FSSecurity)
public class Security : NSObject

  • Represents a set of storage options.

    See more

    Declaration

    Swift

    @objc(FSStorageOptions)
public class StorageOptions : NSObject

  • Represents a set of options for uploading items to a given storage location.

    See more

    Declaration

    Swift

    @objc(FSUploadOptions)
public class UploadOptions : NSObject

  • An operation that simplifies state flag handling and provides a method to finish a task delivering a result containing either a Success response or an Error response.

    State behavior:

    • The operation, regardless of state, will always return isReady true.
    • An executing operation will return isExecuting true.
    • A finished operation will return isFinished true.
    • A cancelled operation will return isCancelled true.
    See more

    Declaration

    Swift

    open class BaseOperation<Success> : Operation

  • Converts the image to black and white.

    See more

    Declaration

    Swift

    public class ASCIITransform : Transform

  • Converts a video or audio to a different format, resolution, sample rate, etc.

    See more

    Declaration

    Swift

    public class AVTransform : Transform

  • Converts a set of images to a GIF file.

    See more

    Declaration

    Swift

    public class AnimateTransform : Transform

  • 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.

    See more

    Declaration

    Swift

    public class AutoImageTransform : Transform

  • Converts the image to black and white.

    See more

    Declaration

    Swift

    public class BlackAndWhiteTransform : Transform

  • Blur selected faces contained inside an image.

    See more

    Declaration

    Swift

    public class BlurFacesTransform : Transform

  • Applies a blurring effect to the image.

    See more

    Declaration

    Swift

    public class BlurTransform : Transform

  • Applies a border effect to the image.

    See more

    Declaration

    Swift

    public class BorderTransform : Transform

  • Takes the file or files that are passed into it and compresses them into a zip file.

    See more

    Declaration

    Swift

    public class CacheTransform : Transform

  • Applies a circle border effect to the image.

    See more

    Declaration

    Swift

    public class CircleTransform : Transform

  • 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.

    See more

    Declaration

    Swift

    public class CollageTransform : Transform

  • Class that is used for creating and sanitizing collection of file handles, storage aliases, or external urls.

    See also CollageTransform.

    See more

    Declaration

    Swift

    @objc(FSCollageTransformCollection)
public class CollageTransformCollection : NSObject

  • 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.

    For the best results, compress should be the last task in your transformation chain.

    Important

    Works only with PNG and JPG files.
    See more

    Declaration

    Swift

    public class CompressTransform : Transform

  • Converts the image to a different format.

    Matrix of supported conversions can be found here: https://cdn.filestackcontent.com/UPqbkTIETnGaQJa1nqnG?dl=true

    See more

    Declaration

    Swift

    public class ConvertTransform : Transform

  • 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.

    See more

    Declaration

    Swift

    public class CopyrightTransform : Transform

  • Crops selected faces contained inside an image.

    See more

    Declaration

    Swift

    public class CropFacesTransform : Transform

  • Crops the image to a specified rectangle.

    See more

    Declaration

    Swift

    public class CropTransform : Transform

  • Detects the faces contained inside an image.

    See more

    Declaration

    Swift

    public class DetectFacesTransform : Transform

  • 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.

    For more information, please check: https://www.filestack.com/docs/concepts/tasks/document-detection/

    See more

    Declaration

    Swift

    public class DocumentDetectionTransform : Transform

  • Smartly analyzes a photo and performs color correction and other enhancements to improve the overall quality of the image.

    See more

    Declaration

    Swift

    public class EnhanceTransform : Transform

  • Returns default file if the source of the transformation does not work or the transformation fails.

    See more

    Declaration

    Swift

    public class FallbackTransform : Transform

  • Flips/mirrors the image vertically.

    See more

    Declaration

    Swift

    public class FlipTransform : Transform

  • Flips/mirrors the image horizontally.

    See more

    Declaration

    Swift

    public class FlopTransform : Transform

  • Returns the width and height of a given image.

    See more

    Declaration

    Swift

    public class ImageSizeTransform : Transform

  • Minifies your CSS files.

    See more

    Declaration

    Swift

    public class MinifyCSSTransform : Transform

  • Minifies your JavaScript files.

    See more

    Declaration

    Swift

    public class MinifyJSTransform : Transform

  • Changes the image brightness, saturation and hue.

    See more

    Declaration

    Swift

    public class ModulateTransform : Transform

  • Converts the image to monochrome.

    See more

    Declaration

    Swift

    public class MonochromeTransform : Transform

  • Returns a negative image by portraying the lightest area as the darkest and the darkest areas as the lightest.

    See more

    Declaration

    Swift

    public class NegativeTransform : Transform

  • Removes any metadata embedded in an image.

    See more

    Declaration

    Swift

    public class NoMetadataTransform : Transform

  • 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.

    See more

    Declaration

    Swift

    public class OCRTransform : Transform

  • Change the image to look like it was oil painted.

    See more

    Declaration

    Swift

    public class OilPaintTransform : Transform

  • Converts a PDF to a specific orientation, page format, and, optionally, extracts specific pages.

    See more

    Declaration

    Swift

    public class PDFConvertTransform : Transform

  • Gets information about a PDF document.

    For more information see https://www.filestack.com/docs/api/processing/#pdf-info

    See more

    Declaration

    Swift

    public class PDFInfoTransform : Transform

  • Converts a PDF to black and white version.

    See more

    Declaration

    Swift

    public class PDFMonochromeTransform : Transform

  • Changes image brightness, saturation and hue.

    See more

    Declaration

    Swift

    public class PartialBlurTransform : Transform

  • Changes image brightness, saturation and hue.

    See more

    Declaration

    Swift

    public class PartialPixelateTransform : Transform

  • Pixelates selected faces contained inside an image.

    See more

    Declaration

    Swift

    public class PixelateFacesTransform : Transform

  • Pixelates the image.

    See more

    Declaration

    Swift

    public class PixelateTransform : Transform

  • Applies a Polaroid border effect to the image.

    See more

    Declaration

    Swift

    public class PolaroidTransform : Transform

  • Converts an image to progressive JPEG.

    This is ideal for large images that will be displayed while downloading over a slow connection, allowing a reasonable preview after receiving only a portion of the data. However, support for progressive JPEGs is not universal.

    When progressive JPEGs are received by programs that do not support them (such as versions of Internet Explorer before Windows 7) the software displays the image only after it has been completely downloaded.

    See more

    Declaration

    Swift

    public class ProgressiveJPEGTransform : Transform

  • Sets the quality of your JPG or WEBP image without the danger of possibly generating a larger file.

    See more

    Declaration

    Swift

    public class QualityTransform : Transform

  • Removes the red eye effect from photos.

    See more

    Declaration

    Swift

    public class RedEyeRemovalTransform : Transform

  • Resizes the image to a given width and height using a particular fit and alignment mode.

    See more

    Declaration

    Swift

    public class ResizeTransform : Transform

  • Rotates an image in a range from 0 to 359 degrees or based on Exif information.

    See more

    Declaration

    Swift

    public class RotateTransform : Transform

  • Rounds the image’s corners.

    See more

    Declaration

    Swift

    public class RoundedCornersTransform : Transform

  • Returns whether the image if safe to display.

    See more

    Declaration

    Swift

    public class SecureForWorkTransform : Transform

  • Converts the image to sepia color.

    See more

    Declaration

    Swift

    public class SepiaTransform : Transform

  • Applies a shadow border effect to the image.

    See more

    Declaration

    Swift

    public class ShadowTransform : Transform

  • Applies a sharpening effect to the image.

    See more

    Declaration

    Swift

    public class SharpenTransform : Transform

  • Analyzes and returns any tags associated to this image.

    Example of returned response:

    {
    "tags": {
        "auto": {
            "cat": 98,
            "cat like mammal": 77,
            "close up": 78,
            "european shorthair": 68,
            "fauna": 84,
            "mammal": 93,
            "small to medium sized cats": 76,
            "tabby cat": 72,
            "vertebrate": 92,
            "whiskers": 92
        }
    }
}
    See more

    Declaration

    Swift

    public class TagsTransform : Transform

  • Applies a torn edge border effect to the image.

    See more

    Declaration

    Swift

    public class TornEdgesTransform : Transform

  • 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.

    See more

    Declaration

    Swift

    public class URLScreenshotTransform : Transform

  • Upscales the image making it two times bigger.

    See more

    Declaration

    Swift

    public class UpscaleTransform : Transform

  • Applies a vignette border effect to the image.

    See more

    Declaration

    Swift

    public class VignetteTransform : Transform

  • Watermarks the image by overlaying another image on top of your main image.

    See more

    Declaration

    Swift

    public class WatermarkTransform : Transform

  • Takes the file or files that are passed into it and compresses them into a zip file.

    See more

    Declaration

    Swift

    public class ZipTransform : Transform