Class TransformArgs

Arguments for the asynchronous `get_transform_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the source file, and exactly one variant of `transform_type` must be set to say what to produce from it. At most one options message may be set, and it must be the one belonging to the requested `transform_type`. Options that belong to a different transform type are rejected with `invalid_options_error` rather than ignored, so that a request whose parameters were misassembled fails visibly instead of quietly producing the wrong output.

Inheritance

object

TransformArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Dropbox.Api.Riviera

Assembly: Dropbox.Api.dll

Syntax

public class TransformArgs

Constructors

TransformArgs(TransformType, FileIdOrUrl, ThumbnailOptions, ImageOptions, VideoFrameOptions)

Initializes a new instance of the TransformArgs class.

Declaration

public TransformArgs(TransformType transformType, FileIdOrUrl fileIdOrUrl = null, ThumbnailOptions thumbnail = null, ImageOptions image = null, VideoFrameOptions videoFrame = null)

Parameters

Type	Name	Description
TransformType	transformType	What to produce from the source file. Required.
FileIdOrUrl	fileIdOrUrl	Identifier of the source file to transform. Callers must set exactly one of the FileIdOrUrl variants. The referenced file must be in a format the requested transform_type supports; see the route description for the per-transform format lists. Requests against unsupported formats fail with unsupported_format_error.
ThumbnailOptions	thumbnail	Options for TransformType.thumbnail.
ImageOptions	image	Options for TransformType.image and TransformType.image_pdf.
VideoFrameOptions	videoFrame	Options for TransformType.video_frame.

Properties

FileIdOrUrl

Identifier of the source file to transform. Callers must set exactly one of the `FileIdOrUrl` variants. The referenced file must be in a format the requested `transform_type` supports; see the route description for the per-transform format lists. Requests against unsupported formats fail with `unsupported_format_error`.

Declaration

public FileIdOrUrl FileIdOrUrl { get; protected set; }

Property Value

Type	Description
FileIdOrUrl

Image

Options for `TransformType.image` and `TransformType.image_pdf`.

Declaration

public ImageOptions Image { get; protected set; }

Property Value

Type	Description
ImageOptions

Thumbnail

Options for `TransformType.thumbnail`.

Declaration

public ThumbnailOptions Thumbnail { get; protected set; }

Property Value

Type	Description
ThumbnailOptions

TransformType

What to produce from the source file. Required.

Declaration

public TransformType TransformType { get; protected set; }

Property Value

Type	Description
TransformType

VideoFrame

Options for `TransformType.video_frame`.

Declaration

public VideoFrameOptions VideoFrame { get; protected set; }

Property Value

Type	Description
VideoFrameOptions