com.dropbox.core.v2.check

Class DbxAppCheckRequests

java.lang.Object

com.dropbox.core.v2.check.DbxAppCheckRequests

public class DbxAppCheckRequests
extends java.lang.Object

Routes in namespace "check".

Constructor Summary

Constructors

Constructor and Description
DbxAppCheckRequests(DbxRawClientV2 client)

Method Summary

Modifier and Type	Method and Description
EchoResult	app() 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.
EchoResult	app(java.lang.String query) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbxAppCheckRequests

public DbxAppCheckRequests(DbxRawClientV2 client)

Method Detail

app

public EchoResult app()
               throws DbxApiException,
                      DbxException

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.

The query request parameter will default to "\"\"" (see app(String)).

Returns:

EchoResult contains the result returned from the Dropbox servers.

Throws:

DbxApiException

DbxException

app

public EchoResult app(java.lang.String query)
               throws DbxApiException,
                      DbxException

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.

Parameters:

query - The string that you'd like to be echoed back to you. Must not be null.

Returns:

EchoResult contains the result returned from the Dropbox servers.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DbxApiException

DbxException