[**@sankhyalabs/core**](../README.md) • **Docs**

***

[@sankhyalabs/core](../globals.md) / OnboardingUtils

# Class: OnboardingUtils

## Constructors

### new OnboardingUtils()

> `private` **new OnboardingUtils**(): [`OnboardingUtils`](OnboardingUtils.md)

#### Returns

[`OnboardingUtils`](OnboardingUtils.md)

#### Source

src/utils/OnboardingUtils.ts:5

## Properties

### USER\_GUIDE\_TAG\_ID

> `static` `private` `readonly` **USER\_GUIDE\_TAG\_ID**: `"userGuideSnippet"` = `"userGuideSnippet"`

#### Source

src/utils/OnboardingUtils.ts:2

***

### instance

> `static` `private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)

#### Source

src/utils/OnboardingUtils.ts:3

## Methods

### init()

> **init**(`apiKey`, `ctx`): `Promise`\<`void`\>

#### Parameters

• **apiKey**: `string`

• **ctx**: `EnvironmentContext`

#### Returns

`Promise`\<`void`\>

#### Source

src/utils/OnboardingUtils.ts:14

***

### injectScript()

> `private` **injectScript**(`apiKey`): `void`

#### Parameters

• **apiKey**: `string`

#### Returns

`void`

#### Source

src/utils/OnboardingUtils.ts:23

***

### register()

> `private` **register**(`ctx`): `void`

#### Parameters

• **ctx**: `EnvironmentContext`

#### Returns

`void`

#### Source

src/utils/OnboardingUtils.ts:34

***

### getInstance()

> `static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)

#### Returns

[`OnboardingUtils`](OnboardingUtils.md)

#### Source

src/utils/OnboardingUtils.ts:7