# Builder

This class is used with [`Sentiance.init(SdkConfig, OnInitCallback)`](https://docs.sentiance.com/important-topics/sdk/api-reference/sentiance#init).

## Builder API

### `Builder`

> ```java
> Builder(String appId, String secret, Notification notification)
> ```
>
> Creates a builder object used for initializing the Sentiance SDK.
>
> **Please note: hard-coded credentials are not secure. Load your Sentiance credentials from a secure source such a remote server, and store them securely on the device.**

| Parameters   |                                                                                                                                          |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| appId        | The Sentiance app credential ID.                                                                                                         |
| secret       | The Sentiance app credential secret.                                                                                                     |
| notification | A [`Notification`](https://developer.android.com/reference/android/app/Notification) used by the SDK when starting a foreground service. |

### `baseURL()`

> ```java
> Builder baseURL(String url)
> ```
>
> Sets the Sentiance API URL.

| Parameters |                        |
| ---------- | ---------------------- |
| url        | The Sentiance API URL. |

### `build()`

> ```java
> SdkConfig build()
> ```
>
> Builds an [`SdkConfig`](https://docs.sentiance.com/important-topics/sdk/api-reference/android/sdkconfig) object.

| Parameters |                                                 |
| ---------- | ----------------------------------------------- |
| id         | The ID used when starting a foreground service. |

### `setMetaUserLinker`

{% hint style="warning" %}
This method was replaced by **setUserLinker(UserLinker)** in v6.0.0.
{% endhint %}

> ```java
> Builder setMetaUserLinker(MetaUserLinker linker)
> ```
>
> Sentiance assigns to each user a unique ID. You can link your app's user to the Sentiance user using meta-user linking. The linking step involves server-to-server communication, and is triggered by the SDK via this meta-user linking callback.
>
> Learn more about Meta-User linking [here](https://github.com/sentiance/v4-docs/blob/main/sdk/api-reference/android/sdkconfig/broken-reference/README.md).

| Parameters |                                                                                                                                       |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| linker     | A [`MetaUserLinker`](https://docs.sentiance.com/important-topics/sdk/api-reference/android/userlinker) which will handle the linking. |

### `setMetaUserLinker`

{% hint style="warning" %}
This method was replaced by **setUserLinker(UserLinkerAsync)** in v6.0.0.
{% endhint %}

> ```java
> Builder setMetaUserLinker(MetaUserLinkerAsync linker)
> ```
>
> Same as [`setMetaUserLinker(MetaUserLinker)`](#setmetauserlinker) but accepts an async linker instead.

| Parameters |                                                                                                                                                 |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| linker     | A [`MetaUserLinkerAsync`](https://docs.sentiance.com/important-topics/sdk/api-reference/android/userlinkerasync) which will handle the linking. |

### `setNotificationId`

> ```java
> Builder setNotificationId(int Id)
> ```
>
> The default notification ID used by the SDK when starting a service is **2123874432**. If your app already shows a persistent notification when running, you can pass your existing notification ID and have a single notification show up in the panel.

| Parameters |                                                 |
| ---------- | ----------------------------------------------- |
| id         | The ID used when starting a foreground service. |

### `setOnSdkStatusUpdateHandler`

> ```java
> Builder setOnSdkStatusUpdateHandler(OnSdkStatusUpdateHandler handler)
> ```
>
> At runtime, the SDK will occasionally send status updates to your app. These are concerning the detection status and environment changes (e.g. location availability, device configuration changes, etc.). You can set a handler here to capture these updates.

| Parameters |                                                                                                                                                                                                                                                             |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| handler    | The [`OnSdkStatusUpdateHandler`](https://docs.sentiance.com/important-topics/sdk/api-reference/android/onsdkstatusupdatehandler) which will receive [`SdkStatus`](https://docs.sentiance.com/important-topics/sdk/api-reference/android/sdkstatus) updates. |

### `setTriggeredTripsEnabled`

> ```java
> Builder setTriggeredTripsEnabled(boolean enabled)
> ```
>
> Enables triggered trips mode on the SDK.
>
> Learn more about triggered trips [here](https://github.com/sentiance/v4-docs/blob/main/sdk/api-reference/android/sdkconfig/broken-reference/README.md).

| Parameters |                                   |
| ---------- | --------------------------------- |
| enabled    | `true` to enable triggered trips. |

### `setUserLinker`

> ```java
> Builder setUserLinker(UserLinker linker)
> ```
>
> Sentiance assigns to each user a unique ID. You can link your app's user to the Sentiance user using user linking. The linking step involves server-to-server communication, and is triggered by the SDK via this user linking callback.
>
> Learn more about user linking [here](https://github.com/sentiance/v4-docs/blob/main/sdk/api-reference/android/sdkconfig/broken-reference/README.md).

| Parameters |                                                                                                                                   |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------- |
| linker     | A [`UserLinker`](https://docs.sentiance.com/important-topics/sdk/api-reference/android/userlinker) which will handle the linking. |

### `setUserLinker`

> ```java
> Builder setUserLinker(UserLinkerAsync linker)
> ```
>
> Same as [`setUserLinker(UserLinker)`](#setuserlinker) but accepts an async linker instead.

| Parameters |                                                                                                                                             |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| linker     | A [`UserLinkerAsync`](https://docs.sentiance.com/important-topics/sdk/api-reference/android/userlinkerasync) which will handle the linking. |