Package com.dropbox.core.v2.check

Class DbxUserCheckRequests

java.lang.Object
com.dropbox.core.v2.check.DbxUserCheckRequests
public class DbxUserCheckRequests extends Object
Routes in namespace "check".

  • Constructor Summary

    Constructors
    Constructor
    Description
    DbxUserCheckRequests(DbxRawClientV2 client)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    EchoResult
    user()
    This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API.
    EchoResult
    user(String query)
    This endpoint performs User Authentication, validating the supplied access token, 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 Details

    • DbxUserCheckRequests

      public DbxUserCheckRequests(DbxRawClientV2 client)

  • Method Details

    • user

      public EchoResult user() throws EchoErrorException, DbxException
      This endpoint performs User Authentication, validating the supplied access token, 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 access token is valid.

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

      Returns:
      EchoResult contains the result returned from the Dropbox servers.
      Throws:
      EchoErrorException
      DbxException

    • user

      public EchoResult user(String query) throws EchoErrorException, DbxException
      This endpoint performs User Authentication, validating the supplied access token, 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 access token is valid.
      Parameters:
      query - The string that you'd like to be echoed back to you. Must have length of at most 500 and not be null.
      Returns:
      EchoResult contains the result returned from the Dropbox servers.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.
      EchoErrorException
      DbxException