Usage: SDK initialization

Set your credentials and get authorization of usage.

Initialize

Set a configuration and initialize. The RookConfiguration requires the following parameters:

• clientUUID
• secretKey
• environment
• enableBackgroundSync: If true yesterday sync and steps tracking will start when initRook is called.

void initialize() {
  const environment =
  kDebugMode ? RookEnvironment.sandbox : RookEnvironment.production;

  final rookConfiguration = RookConfiguration(
    clientUUID: clientUUID,
    secretKey: secretKey,
    environment: environment,
    enableBackgroundSync: true,
  );

  // MUST be called first if you want to enable native logs
  if (kDebugMode) {
    HCRookConfigurationManager.enableNativeLogs();
  }

  HCRookConfigurationManager.setConfiguration(rookConfiguration);

  HCRookConfigurationManager.initRook().then((_) {
    // Success
  }).catchError((exception) {
    // Hanlde error
  });
}

tip

We recommend you to ask your users if they want to enable the automatic sync and steps tracking, then save their preference in local storage and set enableBackgroundSync conditionally.

Recommendations

When you initialize with initRook the SDK an HTTP request is made, so you should only initialize the sdk once.