Class RivieraUserRoutes

The routes for the Dropbox.Api.Riviera namespace

Inheritance

object

RivieraUserRoutes

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

Assembly: Dropbox.Api.dll

Syntax

public class RivieraUserRoutes

Methods

BeginGetMarkdownAsync(FileIdOrUrl, bool, bool, AsyncCallback, object)

Declaration

public IAsyncResult BeginGetMarkdownAsync(FileIdOrUrl fileIdOrUrl = null, bool enableOcr = false, bool embedImages = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl
bool	enableOcr
bool	embedImages
AsyncCallback	callback
object	callbackState

Returns

Type	Description
IAsyncResult

BeginGetMarkdownAsync(GetMarkdownArgs, AsyncCallback, object)

Begins an asynchronous send to the get markdown async route.

Declaration

public IAsyncResult BeginGetMarkdownAsync(GetMarkdownArgs getMarkdownArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetMarkdownArgs	getMarkdownArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMarkdownAsyncCheck(PollArg, AsyncCallback, object)

Begins an asynchronous send to the get markdown async check route.

Declaration

public IAsyncResult BeginGetMarkdownAsyncCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMarkdownAsyncCheck(string, AsyncCallback, object)

Begins an asynchronous send to the get markdown async check route.

Declaration

public IAsyncResult BeginGetMarkdownAsyncCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMetadataAsync(FileIdOrUrl, AsyncCallback, object)

Declaration

public IAsyncResult BeginGetMetadataAsync(FileIdOrUrl fileIdOrUrl = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl
AsyncCallback	callback
object	callbackState

Returns

Type	Description
IAsyncResult

BeginGetMetadataAsync(GetMetadataArgs, AsyncCallback, object)

Begins an asynchronous send to the get metadata async route.

Declaration

public IAsyncResult BeginGetMetadataAsync(GetMetadataArgs getMetadataArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetMetadataArgs	getMetadataArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMetadataAsyncCheck(PollArg, AsyncCallback, object)

Begins an asynchronous send to the get metadata async check route.

Declaration

public IAsyncResult BeginGetMetadataAsyncCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMetadataAsyncCheck(string, AsyncCallback, object)

Begins an asynchronous send to the get metadata async check route.

Declaration

public IAsyncResult BeginGetMetadataAsyncCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTranscriptAsync(FileIdOrUrl, TimestampLevel, string, string, AsyncCallback, object)

Declaration

public IAsyncResult BeginGetTranscriptAsync(FileIdOrUrl fileIdOrUrl = null, TimestampLevel timestampLevel = null, string includedSpecialWords = "", string audioLanguage = "", AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl
TimestampLevel	timestampLevel
string	includedSpecialWords
string	audioLanguage
AsyncCallback	callback
object	callbackState

Returns

Type	Description
IAsyncResult

BeginGetTranscriptAsync(GetTranscriptArgs, AsyncCallback, object)

Begins an asynchronous send to the get transcript async route.

Declaration

public IAsyncResult BeginGetTranscriptAsync(GetTranscriptArgs getTranscriptArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTranscriptArgs	getTranscriptArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTranscriptAsyncCheck(PollArg, AsyncCallback, object)

Begins an asynchronous send to the get transcript async check route.

Declaration

public IAsyncResult BeginGetTranscriptAsyncCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTranscriptAsyncCheck(string, AsyncCallback, object)

Begins an asynchronous send to the get transcript async check route.

Declaration

public IAsyncResult BeginGetTranscriptAsyncCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

EndGetMarkdownAsync(IAsyncResult)

Waits for the pending asynchronous send to the get markdown async route to complete

Declaration

public LaunchResultBase EndGetMarkdownAsync(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LaunchResultBase	The response to the send request

EndGetMarkdownAsyncCheck(IAsyncResult)

Waits for the pending asynchronous send to the get markdown async check route to complete

Declaration

public GetMarkdownAsyncCheckResult EndGetMarkdownAsyncCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetMarkdownAsyncCheckResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndGetMetadataAsync(IAsyncResult)

Waits for the pending asynchronous send to the get metadata async route to complete

Declaration

public LaunchResultBase EndGetMetadataAsync(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LaunchResultBase	The response to the send request

EndGetMetadataAsyncCheck(IAsyncResult)

Waits for the pending asynchronous send to the get metadata async check route to complete

Declaration

public GetMetadataAsyncCheckResult EndGetMetadataAsyncCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetMetadataAsyncCheckResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndGetTranscriptAsync(IAsyncResult)

Waits for the pending asynchronous send to the get transcript async route to complete

Declaration

public LaunchResultBase EndGetTranscriptAsync(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LaunchResultBase	The response to the send request

EndGetTranscriptAsyncCheck(IAsyncResult)

Waits for the pending asynchronous send to the get transcript async check route to complete

Declaration

public GetTranscriptAsyncCheckResult EndGetTranscriptAsyncCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTranscriptAsyncCheckResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetMarkdownAsyncAsync(FileIdOrUrl, bool, bool)

Declaration

public Task<LaunchResultBase> GetMarkdownAsyncAsync(FileIdOrUrl fileIdOrUrl = null, bool enableOcr = false, bool embedImages = false)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl
bool	enableOcr
bool	embedImages

Returns

Type	Description
Task<LaunchResultBase>

GetMarkdownAsyncAsync(GetMarkdownArgs)

Asynchronous document-to-markdown conversion for supported file formats.

Declaration

public Task<LaunchResultBase> GetMarkdownAsyncAsync(GetMarkdownArgs getMarkdownArgs)

Parameters

Type	Name	Description
GetMarkdownArgs	getMarkdownArgs	The request parameters

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetMarkdownAsyncCheckAsync(PollArg)

Returns the status or result of specified get_markdown_async task.

Declaration

public Task<GetMarkdownAsyncCheckResult> GetMarkdownAsyncCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
Task<GetMarkdownAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetMarkdownAsyncCheckAsync(string)

Returns the status or result of specified get_markdown_async task.

Declaration

public Task<GetMarkdownAsyncCheckResult> GetMarkdownAsyncCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
Task<GetMarkdownAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetMetadataAsyncAsync(FileIdOrUrl)

Declaration

public Task<LaunchResultBase> GetMetadataAsyncAsync(FileIdOrUrl fileIdOrUrl = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl

Returns

Type	Description
Task<LaunchResultBase>

GetMetadataAsyncAsync(GetMetadataArgs)

Asynchronous file metadata extraction for supported file formats.

Declaration

public Task<LaunchResultBase> GetMetadataAsyncAsync(GetMetadataArgs getMetadataArgs)

Parameters

Type	Name	Description
GetMetadataArgs	getMetadataArgs	The request parameters

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetMetadataAsyncCheckAsync(PollArg)

Returns the status or result of specified get_metadata_async task.

Declaration

public Task<GetMetadataAsyncCheckResult> GetMetadataAsyncCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
Task<GetMetadataAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetMetadataAsyncCheckAsync(string)

Returns the status or result of specified get_metadata_async task.

Declaration

public Task<GetMetadataAsyncCheckResult> GetMetadataAsyncCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
Task<GetMetadataAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetTranscriptAsyncAsync(FileIdOrUrl, TimestampLevel, string, string)

Declaration

public Task<LaunchResultBase> GetTranscriptAsyncAsync(FileIdOrUrl fileIdOrUrl = null, TimestampLevel timestampLevel = null, string includedSpecialWords = "", string audioLanguage = "")

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl
TimestampLevel	timestampLevel
string	includedSpecialWords
string	audioLanguage

Returns

Type	Description
Task<LaunchResultBase>

GetTranscriptAsyncAsync(GetTranscriptArgs)

Asynchronous transcript generation for audio and video files.

Declaration

public Task<LaunchResultBase> GetTranscriptAsyncAsync(GetTranscriptArgs getTranscriptArgs)

Parameters

Type	Name	Description
GetTranscriptArgs	getTranscriptArgs	The request parameters

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetTranscriptAsyncCheckAsync(PollArg)

Returns the status or result of specified get_transcript_async task.

Declaration

public Task<GetTranscriptAsyncCheckResult> GetTranscriptAsyncCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
Task<GetTranscriptAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetTranscriptAsyncCheckAsync(string)

Returns the status or result of specified get_transcript_async task.

Declaration

public Task<GetTranscriptAsyncCheckResult> GetTranscriptAsyncCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
Task<GetTranscriptAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.