概要

Onboardingが提供しているJavaScript APIについてのドキュメントです。

JavaScript API一覧

以下がOnboardingが提供しているAPIの一覧です。

メソッド名	引数	引数の型	概要	返却値	返却値の型
`showIntro()`			Onboardingイントロを表示
`hasIntro()`			Onboardingイントロが利用可能かを判定	`true` or `false`	boolean
`changeGoal()`	`第一引数`: 表示したいゴールID	`第一引数`: string	第一引数に指定されたゴールが起動
`changeStep()`	`第一引数`: 表示したいゴールID `第二引数`: 表示したいステップID	`第一引数`: string `第二引数`: string	第一引数に指定されたゴールかつ、第二引数に指定されたステップが起動
`getIncompleteGoalIds()`			未完了のゴールIDの一覧を取得	未完了のゴールID一覧	array
`setCheckedGoalIds()`	`第一引数`: チェックをつけたいゴールIDの配列	`第一引数`: array	イントロ上で、指定したゴールにチェックを付与
`clearCheckedGoalIds()`			`setCheckedGoalIds()` によって付与したチェックのステータスをリセット
`setCustomQueryParams()`	`第一引数`: 追加または更新したい埋め込みパラメーターのキーと値	`第一引数`: object	埋め込みパラメーターの再設定
`updateGuideData()`			実行時点の埋め込みパラメーターに応じたOnboardingのガイド一式が再取得され、表示が更新

※ 上記APIは、STANDSMotionオブジェクトに定義されています。ご利用の際はSTANDSMotion.{メソッド名} の形式で記述してください。

APIの利用例の一部をご紹介します。

showIntro()を利用し「お客さまUI上に設置したボタンからイントロを表示する」設定を行っています。

これにより、お客さまの画面に合わせたデザインでOnboardingのランチャーボタンを組み込むことが可能になります。