Extra: Data sources

Show a connections page for other data sources inside the app.

Introduction

This feature included in rook-sdk allows developers to retrieve a list of available API data sources to build a custom connections page. Also, a pre-built connections page can be shown for immediate implementation.

Android Studio

Go to the main Android Studio section to see the IDE configuration.

Getting started

Android configuration

Go to the main Android configuration section to see the basic configuration.

Logging

Go to the main Logging section to configure logs.

Usage

Initialize

Go to the main Initialize and Update userID sections to initialize.

RookDataSources

You can call RookDataSources functions by creating an instance with a context:

// It's recommended to use this instance as a singleton with a ServiceLocator or Dependency Injection.
val rookDataSources = RookDataSources(context)

rookDataSources.doSomething()

Or using the Companion object and providing a context with each call:

RookDataSources.doSomething(context)

Get data source authorizer

To get the authorization url for a specific data source call getDataSourceAuthorizer:

• If the user is not authorized, an authorizationUrl is provided, otherwise authorizationUrl will be null.

Allowed values: Garmin, Oura, Polar, Fitbit, Withings, Whoop, Dexcom.

rookDataSources.getDataSourceAuthorizer("Fitbit").fold(
    { dataSourceAuthorizer ->
        val url = dataSourceAuthorizer.authorizationUrl

        // Open url in a web view or web browser
    },
    { throwable ->
        // Handle error
    }
)

Get authorized data sources

To get all authorized data sources for the current user getAuthorizedDataSources:

Please note that this only represents the user connection status, and not whether the data source is currently active (sending data) or has granted permissions.

For SDK-based data sources (such as Apple Health and Health Connect), this endpoint will return true if the user was created by SDK with the corresponding updateUserId function, means that the user is linked with ROOK via SDK, but not indicates if the user granted permissions or not.

For API-based data sources (such as Fitbit, Garmin, and Withings), true indicates that the user has authorized ROOK to retrieve data through the respective third-party platform.

coroutineScope.launch {
    rookDataSources.getAuthorizedDataSources().fold(
        { authorizedDataSources ->
            // Data Sources obtained successfully
        },
        { throwable ->
            // Error obtaining Data Sources
        },
    )
}

tip

The properties of the AuthorizedDataSources are nullable to differentiate between available and unavailable data sources.

Get authorized data sources V2

getAuthorizedDataSourcesV2 is an improved version of getAuthorizedDataSources that returns a list of AuthorizedDataSourceV2 with the name, authorization status and image URL of each data source.

Please note that this only represents the user connection status, and not whether the data source is currently active (sending data) or has granted permissions.

For SDK-based data sources (such as Apple Health and Health Connect), this endpoint will return true if the user was created by SDK with the corresponding updateUserId function, means that the user is linked with ROOK via SDK, but not indicates if the user granted permissions or not.

For API-based data sources (such as Fitbit, Garmin, and Withings), true indicates that the user has authorized ROOK to retrieve data through the respective third-party platform.

coroutineScope.launch {
    rookDataSources.getAuthorizedDataSourcesV2().fold(
        { authorizedDataSources ->
            // Data Sources obtained successfully
        },
        { throwable ->
            // Error obtaining Data Sources
        },
    )
}

Unlink from a data source

To unlink (revoke authorization) from a data source call revokeDataSource:

Allowed values: Garmin, Oura, Polar, Fitbit, Withings, Whoop, Dexcom.

coroutineScope.launch {
    rookDataSources.revokeDataSource("Fitbit").fold(
        {
            // Success
        },
        { throwable ->
            // Hanlde error
        }
    )
}

Pre-built connections page

If you don't want to create your own connections page, you can use our pre-built screen by calling presentDataSourceView:

• redirectUrl (Optional) - After the user successfully connects to a data source, the user will be redirected to this URL.

    rookDataSources.presentDataSourceView().fold(
    { dataSources ->
        // Data Sources activity launched successfully
    },
    { throwable ->
        // Error launching activity
    },
)