Skip to main content

インポート

初期化

.initialize

OneS1ght API キーを検証し、テナント設定を取得します。測位エンジンの起動や端末の対応確認は行いません。

.requestPermission

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

.setLanguage

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

.onDebugLog

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

.reset

セッションを破棄します。以降の API は initialize を再度呼ぶまで notInitialized エラーになります(別のキーでも可)。

状態の取得

.isInitialized

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

.deviceAvailability

測位可能な端末かを判定し、非対応の場合はその理由を返します。

.googleMapKey

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

.sdkVersion

使用中の SDK バージョンを返します。

プロフィール

.createProfile

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

.identify

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

.fetchProfile

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

.replaceProfile

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

.deleteProfile

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

空間の取得

.buildings

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

.floors

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

.floor

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

.zones

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

.locators

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

フロアの指定

.setFloorMap

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

.refreshZones

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

測位セッション

.floorSession

測位セッションを取得します。フロアに関係なく、アプリ全体で同じインスタンス(シングルトン)です。

.begin

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

.end

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

.pause · .resume

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

.isRunning · .isPaused

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

セッションイベント

.onPosition

ユーザーの座標をリアルタイムで返すイベントが発生します。エンジンの頻度のまま届き、毎秒 4 回(デフォルト)はサーバー送信分にのみ適用されます。

.onZoneEnter · .onZoneExit

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

.onZoneDwell

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

.onTriggers

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

.onFloorDetected

ロケーターの BLE 信号でフロアを見つけるとフロア ID で、フロアを見失うと nil でイベントが発生します。

.onStopped

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

.onConfigChanged

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

データ送信

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

.uploadPendingPositions

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

.discardPendingPositions

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

エラー処理

失敗は SdkError(SDK の状態)と ApiError(通信)で届きます。コードの意味はエラーコードを参照してください。Objective-C では NSError.userInfo[@"sdkCode"] に入ります。

モデル

リストは [T]、バイト列は Data です。

Coordinates

Building · Floor

Locator · FloorLocators

Zone

Trigger

Objective-C ブリッジ

以下のファイルをアプリターゲットに追加して 1 回ビルドすると、<Product Module Name>-Swift.h が生成されます。
OneS1ghtBridge.swift

制約

  • UWB 測位はフォアグラウンド専用 — バックグラウンドで停止し、復帰すると測位が再開されます。
  • 座標バッファはメモリ上 — 強制終了すると未送信の座標は失われます。
  • シミュレーターでは測位できません。