セッション¶
ヒューマンスコアリングユースケースの一部です。
セッションとは、分類の対象となる一連の操作の区間です。SDK は init
で 1 つのセッションを開始します。ログアウトやアカウント切り替えなど、アプリだけが知る形でセッションが終わる
ときは SDK に伝え、あるユーザーの操作が次のユーザーの分類に数えられないようにします。
使いどころ¶
- ユーザーがログアウトするとき
- ユーザーがアカウントを切り替えるとき
- 現在のセッション ID が必要なとき。たとえば自分の記録と並べてログに残す場合
前提条件¶
- SDK がインストールされ、初期化されている。クイックスタートを参照してください。
使い方¶
新しいセッションを開始する¶
reset() は現在のセッションを終了し、新しい ID で新しいセッションを開始します。リセット前に収集した証拠は、
新しいセッションの分類には数えられません。同意には影響しません。
現在のセッションを読み取る¶
const info = await Dea.getSessionInfo();
console.log(info.session); // current session id, a UUID
console.log(info.sdk); // { version, core }
console.log(info.device); // { runtime, os, surface, pixelRatio, rotation, maxTouchPoints, sensorRate }
SDK を終了する¶
dispose() は取得を停止し、SDK を解放します。dispose() の後は、init の前と同様に呼び出しが reject され、
再び init を呼び出すと新しいセッションが開始されます。
例¶
ログアウト時にリセットする¶
import * as Dea from '@dea/react-native';
import {authService} from './auth';
export async function logout(navigation: {reset: (state: object) => void}) {
await authService.signOut();
await Dea.reset();
navigation.reset({index: 0, routes: [{name: 'Login'}]});
}
API¶
| メンバー | 戻り値 | 説明 |
|---|---|---|
reset() |
Promise<void> |
セッションを終了し、新しいセッションを開始する |
getSessionInfo() |
Promise<Record<string, unknown>> |
セッション ID、端末、SDK バージョン |
dispose() |
Promise<void> |
取得を停止し、SDK を解放する |