Skip to main content

インポート

Dart

初期化

.initialize

OneS1ght API キーで測位エンジンを初期化します。
Dart

.requestPermission

測位エンジンの利用に必要なアプリ権限をリクエストします。
Dart

.setLanguage

SDK のログ文言の言語を設定します。
ko: 韓国語、 ja: 日本語、 en: 英語、 null: システム設定の言語
Dart

.onDebugLog

SDK のログを受信します。
level: ログレベル、 message: ログメッセージ
Dart

.reset

初期化を取り消し、現在のセッションを破棄します。新しいセッションは作成しないため、続けて使うには initialize を再度呼び出してください(別のキーでも可能です)。
Dart

状態の取得

.isInitialized

初期化に成功したかを返します。
Dart

.deviceAvailability

測位可能な端末かを判定し、非対応の場合はその理由を返します。 Android では initialize() の後に読み取ってください。それより前は判定できず deviceNotSupported を返します。
Dart

.googleMapKey

図面を表示するための Google Maps API キーを返します。
Dart

.sdkVersion

使用中のネイティブ SDK バージョンを返します。
プラグインのバージョンは OneS1ght.pluginVersion を参照してください。
Dart

プロフィール

.createProfile

新しいパーソナライズプロフィールを作成します。成功すると一意のプロフィール ID を返します。
Dart

.identify

収集する測位データを紐付けるプロフィールを設定します。解除する場合は null を設定してください。
Dart

.fetchProfile

プロフィールの属性を取得します。
Dart

.replaceProfile

プロフィールの属性を置き換えます。以前のデータは削除されます。
Dart

.deleteProfile

プロフィール情報を完全に削除します。
Dart

空間の取得

.buildings

テナントに紐付くすべての建物一覧を取得します。
Dart

.floors

建物のフロア一覧を取得します。
Dart

.floor

選択したフロアの詳細情報を取得します。
Dart

.zones

選択したフロアのすべてのゾーンを取得します。
Dart

.locators

選択したフロアのロケーター情報を取得します。
Dart

フロアの指定

.setFloorMap

測位を開始するフロアを指定します。
Dart

.refreshZones

最新のゾーン情報を取得します。
Dart

測位セッション

.floorSession

選択したフロアのロケーターセッションを取得します。
Dart

.begin

ユーザーの測位を開始します。
Dart

.end

ユーザーの測位を終了します。
Dart

.pause · .resume

ユーザーの測位を一時停止・再開します。終了とは異なり、SDK 内の測位エンジンは停止しません。
Dart

.isRunning · .isPaused

測位中かどうかと、一時停止中かどうかを返します。
Dart

セッションイベント

.onPosition

ユーザーの座標をリアルタイムで返すイベントが発生します(デフォルトは毎秒 4 回)。
Dart

.onZoneEnter · .onZoneExit

ゾーンへの進入・退出時にイベントが発生します。
Dart

.onZoneDwell

特定ゾーンの滞在時間が基準(dwellSeconds)を超えるとイベントが発生します。
Dart

.onTriggers

空間内のイベント(施策)が動作するとイベントが発生します。
Dart

.onFloorDetected

ロケーターの BLE 信号を受信するとイベントが発生します。
Dart

.onStopped

ユーザーの測位が停止するとイベントが発生します。
Dart

.onConfigChanged

コンソール画面で設定が変更されるとイベントが発生します。
Dart

データ送信

座標は 300 件または 60 秒ごと、およびバックグラウンド移行時と end() 時に自動で送信されます。

.uploadPendingPositions

溜めた座標を即時送信します。
Dart

.discardPendingPositions

溜めた座標を破棄します。
Dart

エラー処理

失敗はすべて OneS1ghtException で届きます。詳細はエラーコードを参照してください。
Dart

モデル

リストは List<T>、バイト列は Uint8List です。

Coordinates

Building · Floor

Locator · FloorLocators

Zone

Trigger

列挙型(ConfigChange・StopReason・PermissionStatus・DeviceAvailability・LogLevel)はマイナーバージョンで値が増えることがあります — switch に default を置いてください。

制約

  • すべての呼び出しは Future、イベントは Stream — UI をそのまま更新できます。
  • UWB 測位はフォアグラウンド専用で、バックグラウンドで停止し、復帰すると再開します。
  • 座標バッファはアプリのメモリ上に一時保存され、強制終了すると未送信の座標は失われます。
  • エミュレーターでは測位できません。