CheckAppAuthRoutes

public class CheckAppAuthRoutes : DropboxTransportClientOwning

Routes for the checkAppAuth namespace For Objective-C compatible routes see DBCheckRoutes

  • 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

    Swift

    @discardableResult
    public func app(query: String = "") -> RpcRequest<Check.EchoResultSerializer, VoidSerializer>

    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 Check.EchoResult object on success or a Void object on failure.