Class GetOcrArgs

Arguments for the asynchronous `get_ocr_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the image or PDF whose text should be extracted via OCR (optical character recognition).

Inheritance

object

GetOcrArgs

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 GetOcrArgs

Constructors

GetOcrArgs(FileIdOrUrl)

Initializes a new instance of the GetOcrArgs class.

Declaration

public GetOcrArgs(FileIdOrUrl fileIdOrUrl = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the file to run OCR on. Callers must set exactly one of the FileIdOrUrl variants. OCR is supported for image files and PDFs, including scanned / non-text PDFs; 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 file to run OCR on. Callers must set exactly one of the `FileIdOrUrl` variants. OCR is supported for image files and PDFs, including scanned / non-text PDFs; 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