Class GetTextArgs

Arguments for the asynchronous `get_text_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the document whose plain-text content should be extracted.

Inheritance

object

GetTextArgs

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 GetTextArgs

Constructors

GetTextArgs(FileIdOrUrl)

Initializes a new instance of the GetTextArgs class.

Declaration

public GetTextArgs(FileIdOrUrl fileIdOrUrl = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the document to extract text from. Callers must set exactly one of the FileIdOrUrl variants. Text extraction is supported for common document formats (Word, PowerPoint, Excel, PDF, RTF, and Dropbox document types); see the route description for the supported formats. Requests against unsupported formats return unsupported_format_error. NOTE: for the url variant, only Dropbox shared links (www.dropbox.com) are supported. External (non-Dropbox) URLs are not supported and return unsupported_format_error; import the file into Dropbox and reference it by file_id or path instead.

Properties

FileIdOrUrl

Identifier of the document to extract text from. Callers must set exactly one of the `FileIdOrUrl` variants. Text extraction is supported for common document formats (Word, PowerPoint, Excel, PDF, RTF, and Dropbox document types); see the route description for the supported formats. Requests against unsupported formats return `unsupported_format_error`. NOTE: for the `url` variant, only Dropbox shared links (www.dropbox.com) are supported. External (non-Dropbox) URLs are not supported and return `unsupported_format_error`; import the file into Dropbox and reference it by `file_id` or `path` instead.

Declaration

public FileIdOrUrl FileIdOrUrl { get; protected set; }

Property Value

Type	Description
FileIdOrUrl