Class TransformOutput

A completed transform: a handle for retrieving the produced bytes, plus enough metadata to decide whether to retrieve them. The bytes themselves are deliberately not carried here. A completed async result is persisted, so it is bounded by a row-size limit well below the size of a typical converted document -- an inline payload would fail for exactly the large documents this route exists to convert. The transform therefore completes by caching its output and handing back `output_handle`, which `download_transform_output` exchanges for the bytes.

Inheritance

object

TransformOutput

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 TransformOutput

Constructors

TransformOutput(string, ulong, string, string, ulong)

Initializes a new instance of the TransformOutput class.

Declaration

public TransformOutput(string outputHandle = "", ulong size = 0, string format = "", string mimeType = "", ulong expiresTs = 0)

Parameters

Type	Name	Description
string	outputHandle	Opaque, single-purpose handle for the produced bytes. Pass it to download_transform_output to retrieve them. The handle is scoped to the account that created it and cannot be used to read anything other than the output of this transform. It is not a URL and carries no meaning for callers beyond being passed back verbatim.
ulong	size	Size of the produced output in bytes.
string	format	Format of the produced output, as a short lowercase format name such as "pdf", "html", "jpeg", or "png". This reflects what was actually produced, which for some sources differs from what was requested.
string	mimeType	MIME type corresponding to format, for callers that need a Content-Type to hand to a downstream consumer.
ulong	expiresTs	Unix timestamp, in seconds, after which output_handle is no longer accepted. Retrieve the bytes before this point; after it, download_transform_output reports expired_handle_error and the transform has to be requested again.

Properties

ExpiresTs

Unix timestamp, in seconds, after which `output_handle` is no longer accepted. Retrieve the bytes before this point; after it, `download_transform_output` reports `expired_handle_error` and the transform has to be requested again.

Declaration

public ulong ExpiresTs { get; protected set; }

Property Value

Type	Description
ulong

Format

Format of the produced output, as a short lowercase format name such as "pdf", "html", "jpeg", or "png". This reflects what was actually produced, which for some sources differs from what was requested.

Declaration

public string Format { get; protected set; }

Property Value

Type	Description
string

MimeType

MIME type corresponding to `format`, for callers that need a Content-Type to hand to a downstream consumer.

Declaration

public string MimeType { get; protected set; }

Property Value

Type	Description
string

OutputHandle

Opaque, single-purpose handle for the produced bytes. Pass it to `download_transform_output` to retrieve them. The handle is scoped to the account that created it and cannot be used to read anything other than the output of this transform. It is not a URL and carries no meaning for callers beyond being passed back verbatim.

Declaration

public string OutputHandle { get; protected set; }

Property Value

Type	Description
string

Size

Size of the produced output in bytes.

Declaration

public ulong Size { get; protected set; }

Property Value

Type	Description
ulong