Show / Hide Table of Contents

Class CheckAppRoutes

The routes for the Dropbox.Api.Check namespace

Inheritance
System.Object
CheckAppRoutes
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Dropbox.Api.Check.Routes
Assembly: Dropbox.Api.dll
Syntax
public class CheckAppRoutes

Methods

| Improve this Doc View Source

AppAsync(EchoArg)

This endpoint performs App Authentication, validating the supplied app key and secret, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the app key and secret valid.

Declaration
public Task<EchoResult> AppAsync(EchoArg echoArg)
Parameters
Type Name Description
EchoArg echoArg

The request parameters

Returns
Type Description
System.Threading.Tasks.Task<EchoResult>

The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

| Improve this Doc View Source

AppAsync(String)

This endpoint performs App Authentication, validating the supplied app key and secret, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the app key and secret valid.

Declaration
public Task<EchoResult> AppAsync(string query = "")
Parameters
Type Name Description
System.String query

The string that you'd like to be echoed back to you.

Returns
Type Description
System.Threading.Tasks.Task<EchoResult>

The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

| Improve this Doc View Source

BeginApp(EchoArg, AsyncCallback, Object)

Begins an asynchronous send to the app route.

Declaration
public IAsyncResult BeginApp(EchoArg echoArg, AsyncCallback callback, object state = null)
Parameters
Type Name Description
EchoArg echoArg

The request parameters.

System.AsyncCallback callback

The method to be called when the asynchronous send is completed.

System.Object state

A user provided object that distinguished this send from other send requests.

Returns
Type Description
System.IAsyncResult

An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginApp(String, AsyncCallback, Object)

Begins an asynchronous send to the app route.

Declaration
public IAsyncResult BeginApp(string query = "", AsyncCallback callback = null, object callbackState = null)
Parameters
Type Name Description
System.String query

The string that you'd like to be echoed back to you.

System.AsyncCallback callback

The method to be called when the asynchronous send is completed.

System.Object callbackState

A user provided object that distinguished this send from other send requests.

Returns
Type Description
System.IAsyncResult

An object that represents the asynchronous send request.

| Improve this Doc View Source

EndApp(IAsyncResult)

Waits for the pending asynchronous send to the app route to complete

Declaration
public EchoResult EndApp(IAsyncResult asyncResult)
Parameters
Type Name Description
System.IAsyncResult asyncResult

The reference to the pending asynchronous send request

Returns
Type Description
EchoResult

The response to the send request

  • Improve this Doc
  • View Source
In This Article
  • Methods
    • AppAsync(EchoArg)
    • AppAsync(String)
    • BeginApp(EchoArg, AsyncCallback, Object)
    • BeginApp(String, AsyncCallback, Object)
    • EndApp(IAsyncResult)
Back to top Generated by DocFX