DBCHECKAppAuthRoutes

Objective-C

@interface DBCHECKAppAuthRoutes : NSObject

Swift

class DBCHECKAppAuthRoutes : NSObject

Routes for the Check namespace

  • An instance of the networking client that each route will use to submit a request.

    Declaration

    Objective-C

    @property (nonatomic, readonly) id<DBTransportClient> _Nonnull client;

  • Initializes the DBCHECKAppAuthRoutes namespace container object with a networking client.

    Declaration

    Objective-C

    - (nonnull instancetype)init:(nonnull id<DBTransportClient>)client;

  • 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

    Objective-C

    - (nonnull DBRpcTask<DBCHECKEchoResult *, DBNilObject *> *)app;

    Swift

    func app() -> DBRpcTask<DBCHECKEchoResult, DBNilObject>

    Return Value

    Through the response callback, the caller will receive a DBCHECKEchoResult object on success or a void object on failure.

  • 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

    Objective-C

    - (nonnull DBRpcTask<DBCHECKEchoResult *, DBNilObject *> *)app:
    (nullable NSString *)query;

    Swift

    func app(_ query: String?) -> DBRpcTask<DBCHECKEchoResult, DBNilObject>

    Parameters

    query

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

    Return Value

    Through the response callback, the caller will receive a DBCHECKEchoResult object on success or a void object on failure.