ConfigClient

public class ConfigClient extends GoogleApi<FitnessOptions>

Client for accessing custom data types and settings in Google Fit.

Custom data type definitions can be added and then retrieved using createCustomDataType(DataTypeCreateRequest) and readDataType(String).

disableFit() can be used to disconnect your app from Google Fit.

The Config Client should be accessed via the Fitness entry point. Example:


    GoogleSignInAccount gsa = ...;

    Task<DataType> response = Fitness.getConfigClient(this, gsa)
        .readDataType("com.example.my_custom_data_type");

    DataType dataType = Tasks.await(response);
 

Public Method Summary

Task<DataType>
createCustomDataType(DataTypeCreateRequest request)
Defines a new data type which is added to the Google Fit platform on behalf of the current application.
Task<Void>
disableFit()
Disables Google Fit for an app.
Task<DataType>
readDataType(String dataTypeName)
Returns a data type with the specified dataTypeName.

Inherited Method Summary

Public Methods

public Task<DataType> createCustomDataType (DataTypeCreateRequest request)

Defines a new data type which is added to the Google Fit platform on behalf of the current application. Useful for adding a private custom data type for recording app-specific data. Custom data created by one app will not be visible to other apps.

Example:

     Task<DataType> response = Fitness.getConfigClient(this, googleSigninAccount)
         .createCustomDataType(new DataTypeCreateRequest.Builder()
             .setName(DATA_TYPE_NAME)
             .addField(MY_FIELD1)
             .addField(MY_FIELD2)
             .build());
     DataType dataType = Tasks.await(response);
 
Parameters
request the new data type name and fields that need to be added
Returns
  • a task, containing the status of the request. If an existing DataType has the same name but different fields, the operation will fail with CONFLICTING_DATA_TYPE. If application package name does not match DataType's name, the operation will fail with INCONSISTENT_DATA_TYPE status code.

public Task<Void> disableFit ()

Disables Google Fit for an app. Can be used to revoke all granted OAuth access permissions from an app and consequently remove all existing subscriptions and registrations of the app.

Returns
  • Task containing the status of the request

public Task<DataType> readDataType (String dataTypeName)

Returns a data type with the specified dataTypeName. Useful to retrieve shareable data types added by other apps or custom data types added by your app. Custom data types created by other apps will not be returned.

Parameters
dataTypeName name of the data type we want to read
Returns
  • Task containing the status of the request