9 言語の SDK 関数と戻り値リファレンス
Launch の公開関数、引数、正常時の戻り値、失敗時の動作を言語別に確認できます。省略可能な引数と既定値は対応バージョンのソースに従います。
このページは Launch のアカウントアダプターを説明します。内蔵 Licentivo SDK の認可、使用量計測、オフライン API は公式 SDK 関数リファレンスを参照してください。
セッション状態はアカウントを示すだけです。保護対象の業務実行ごとに機能ガードを通してください。
既定はメモリ保存です。ログイン記憶には保護された永続ストレージが必要で、SDK キャッシュとは別に扱います。
復元にはオンラインのアカウント確認が必要です。Launch は通信失敗時にオフライン認可を選びません。公式 SDK が検証します。
Go
対応するソース · v0.1.6 · application.go · runtime.go · client.go · store.go
エラーと失敗時の処理: error != nil; errors.Is(err, launchclient.ErrNoSession); errors.As(err, &apiError)
Connect
Connect(merchantOrigin, productID, licentivoProductID string, trustedKeys map[string]string, options Config) → (*Application, error)- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。trustedKeys / trusted_keys: 署名鍵 ID と公開鍵の対応表で、公式 SDK の署名済み認可を検証します。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
(*Application, error)作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application.Login
Login(ctx context.Context, email, password string) → (State, error)- 役割
- ストアの顧客アカウントでログインし、短期の本人確認アサーションを取得して公式認可 SDK を起動します。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。
- 戻り値
(State, error)アカウント状態を返します。各フィールドは下の戻り値表を参照してください。
Application.Restore
Restore(ctx context.Context) → (State, error)- 役割
- 保存済みセッションを読み込み、オンラインでアカウントを確認し、新しいアサーションを取得して公式 SDK を起動します。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
(State, error)アカウント状態を返します。ErrNoSession または NO_SESSION は保存セッションなしを示します。他のエラーは区別してください。
Application.RunFeature
RunFeature(feature string, action func() error) → error- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application.Logout
Logout(ctx context.Context) → error- 役割
- ローカル認可を停止し、公式 SDK をログアウトしてから Launch セッションを無効化します。未完了のリモート処理は再試行用に保持します。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application.ReleaseDevice
ReleaseDevice(ctx context.Context) → error- 役割
- 明示的ログアウトの互換入口で、Logout と同じアカウントおよびデバイスのログアウト処理を行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application.Close
Close() → void- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
void業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
高度な API と互換 API
NewApplication
NewApplication(config Config) → (*Application, error)- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
(*Application, error)作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
NewApplicationFromFiles
NewApplicationFromFiles(launchPath, productPath string, options Config) → (*Application, error)- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
launchPath, productPath: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
(*Application, error)作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
LoadPublicConfig
LoadPublicConfig(path string) → (PublicConfig, error)- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
path: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
(PublicConfig, error)シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
NewRuntime
NewRuntime(product ProductConfig, runtime RuntimeConfig) → (Runtime, error)- 役割
- 高度な連携向けに公式 SDK アダプターを作成します。本人確認アサーションはメモリ内だけで渡します。
- 引数の説明
product, runtime: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
(Runtime, error)作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
New
New(origin string, allowLocalHTTP bool) → (*Client, error)- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。allowLocalHTTP: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
(*Client, error)作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Client.WithToken
WithToken(token string) → *Client- 役割
- 指定のアカウントトークンを持つクライアントのコピーを返します。信頼されたバックエンド向けです。
- 引数の説明
token: Launch アカウントセッショントークンです。低レベルセッション API や暗号化ストレージだけが返します。
- 戻り値
*Client作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Client.Login
Login(ctx context.Context, email, password string) → (User, error)- 役割
- アカウントを認証し、アカウント情報またはセッションを返します。認可ランタイムは起動しません。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。
- 戻り値
(User, error)アカウント状態を返します。各フィールドは下の戻り値表を参照してください。
Client.LoginSession
LoginSession(ctx context.Context, email, password string) → (Session, error)- 役割
- アカウントを認証し、アカウント情報またはセッションを返します。認可ランタイムは起動しません。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。
- 戻り値
(Session, error)アカウント状態を返します。各フィールドは下の戻り値表を参照してください。
Client.CurrentUser
CurrentUser(ctx context.Context) → (User, error)- 役割
- 現在のアカウント情報を取得します。成功しても保護機能が許可されるわけではありません。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
(User, error)アカウント状態を返します。各フィールドは下の戻り値表を参照してください。
Client.Identity
Identity(ctx context.Context, product, environment string) → (Identity, error)- 役割
- 一度だけ使える本人確認アサーションと公開ルーティング情報を取得します。ライセンスや機能の許可ではありません。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。product: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。
- 戻り値
(Identity, error)アカウント状態を返します。各フィールドは下の戻り値表を参照してください。
Client.SignOut
SignOut(ctx context.Context) → error- 役割
- Launch セッションを無効化してクライアントのトークンを消去します。公式 SDK のデバイスログアウトの代わりにはなりません。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Client.Credential
Credential(ctx context.Context, product, environment string) → (Credential, error)- 役割
- 互換用の旧 API です。長期ライセンス資格情報の方式は廃止されているため失敗します。新規実装には Application を使います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。product: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。
- 戻り値
(Credential, error)常に失敗します。アカウント本人確認の交換 API へ移行してください。
Client.CredentialWithRetry
CredentialWithRetry(ctx context.Context, product, environment string, policy RetryPolicy) → (Credential, error)- 役割
- 互換用の旧 API です。長期ライセンス資格情報の方式は廃止されているため失敗します。新規実装には Application を使います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。product: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。policy: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
(Credential, error)常に失敗します。アカウント本人確認の交換 API へ移行してください。
NewSystemSessionStore
NewSystemSessionStore(directory string) → (SessionStore, error)- 役割
- 保護された永続セッションストレージを作成します。暗号鍵は OS の資格情報保管庫から取得してください。
- 引数の説明
directory: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
(SessionStore, error)作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
ProtectDirectory
ProtectDirectory(directory string) → error- 役割
- ディレクトリを現在の Windows ユーザー、または他の環境のプライベート権限に制限します。
- 引数の説明
directory: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
ServiceUnavailable
ServiceUnavailable(err error) → bool- 役割
- 一時的なサービス停止かを判定します。この判定だけでオフライン認可は許可されません。
- 引数の説明
err: 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
bool真偽値による分類を返します。認可許可ではありません。
APIError.Error / TransportError.Error
Error() → string- 役割
- 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
stringシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
TransportError.Unwrap
Unwrap() → error- 役割
- 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
errorシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
MemoryStore.Load / SessionStore.Load
Load(ctx context.Context, key string) → ([]byte, error)- 役割
- 分離キーでアカウント記録を読み込みます。機密データを含むため SDK にだけ渡してください。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
([]byte, error)機密記録を返します。存在しない場合は言語ごとの規約に従い空値または ErrNoSession になります。
MemoryStore.Save / SessionStore.Save
Save(ctx context.Context, key string, value []byte) → error- 役割
- 分離キーを使ってアカウント記録をアトミックに保存します。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
MemoryStore.Delete / SessionStore.Delete
Delete(ctx context.Context, key string) → error- 役割
- 指定のアカウント記録を削除します。公式 SDK の認可キャッシュやログアウトジャーナルは削除しません。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.Start
Start(ctx context.Context, onError func(error)) → error- 役割
- 公式 SDK の検証とバックグラウンド保守を開始します。アカウントログインと機能保護は別の API で行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。onError: 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.RunFeature
RunFeature(feature string, action func() error) → error- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.Deactivate
Deactivate(ctx context.Context) → error- 役割
- 公式 SDK のデバイスログアウトを行います。Launch セッションの無効化はアプリ側で別途行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
error業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.Close
Close() → void- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
void業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
Python
対応するソース · v0.1.6 · client.py
エラーと失敗時の処理: APIError.code / .status / .retry_after / .retryable; ValueError; SDK exceptions
Application.connect
Application.connect(merchant_origin, product_id, licentivo_product_id, trusted_keys, environment="live", **kwargs) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。trustedKeys / trusted_keys: 署名鍵 ID と公開鍵の対応表で、公式 SDK の署名済み認可を検証します。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application.login
login(email, password, *, pending_attempts=3) → Application (self)- 役割
- ストアの顧客アカウントでログインし、短期の本人確認アサーションを取得して公式認可 SDK を起動します。
- 引数の説明
email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。pending_attempts: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application (self)現在のアプリケーション自身を返します。アカウント情報や認可結果ではありません。
Application.restore
restore() → bool- 役割
- 保存済みセッションを読み込み、オンラインでアカウントを確認し、新しいアサーションを取得して公式 SDK を起動します。
- 戻り値
booltrue は復元成功、false は復元できるセッションがない状態です。拒否、期限切れ、通信失敗はエラーになります。
Application.run_feature
run_feature(name, action) → T- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
T業務コールバックの結果を返します。認可失敗や業務例外はエラーとして通知します。
Application.logout
logout() → bool- 役割
- ローカル認可を停止し、公式 SDK をログアウトしてから Launch セッションを無効化します。未完了のリモート処理は再試行用に保持します。
- 戻り値
booltrue はログアウト確認済み、false はリモートのアカウント終了またはデバイス失効が保留中です。保存エラーが発生する場合もあります。
Application.release_device
release_device() → bool- 役割
- 明示的ログアウトの互換入口で、Logout と同じアカウントおよびデバイスのログアウト処理を行います。
- 戻り値
booltrue はログアウト確認済み、false はリモートのアカウント終了またはデバイス失効が保留中です。保存エラーが発生する場合もあります。
Application.close
close() → None- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
None業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
Application.__enter__ / __exit__
with Application.connect(...) as app: ... → Application / None- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
Application / None業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
高度な API と互換 API
Application.__init__
Application(origin, product_id, product_config, environment="live", store=None, runtime_factory=None, cache_dir=None, sleep=time.sleep, opener=None) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。product_config: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application.from_files
Application.from_files(launch_config, product_config, **kwargs) → Application- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
launch_config, product_config: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
MemoryStore
MemoryStore() → MemoryStore- 役割
- 現在のプロセス内だけで有効なセッションストレージを作成します。
- 戻り値
MemoryStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
WindowsDPAPIStore
WindowsDPAPIStore(directory=None) → WindowsDPAPIStore- 役割
- 保護された永続セッションストレージを作成します。暗号鍵は OS の資格情報保管庫から取得してください。
- 引数の説明
directory: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
WindowsDPAPIStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
APIError
APIError(code, status=0, retry_after=0) → APIError- 役割
- 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 引数の説明
code, status, retry_after: 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
APIErrorシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
MemoryStore.load / WindowsDPAPIStore.load
load(key) → bytes | None- 役割
- 分離キーでアカウント記録を読み込みます。機密データを含むため SDK にだけ渡してください。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
bytes | None機密記録を返します。存在しない場合は言語ごとの規約に従い空値または ErrNoSession になります。
MemoryStore.save / WindowsDPAPIStore.save
save(key, value) → None- 役割
- 分離キーを使ってアカウント記録をアトミックに保存します。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
None業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
MemoryStore.delete / WindowsDPAPIStore.delete
delete(key) → None- 役割
- 指定のアカウント記録を削除します。公式 SDK の認可キャッシュやログアウトジャーナルは削除しません。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
None業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
C#
対応するソース · v0.1.6 · Application.cs · SessionStore.cs
エラーと失敗時の処理: await Task / ValueTask; LaunchException.Code / .Status / .RetryAfterSeconds / .Retryable
Application.Connect
Application.Connect(string merchantOrigin, string productId, string licentivoProductId, Dictionary<string,string> trustedKeys, string environment="live", ISessionStore? store=null, string? cacheDirectory=null) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。trustedKeys / trusted_keys: 署名鍵 ID と公開鍵の対応表で、公式 SDK の署名済み認可を検証します。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。store, cacheDirectory: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application.Login
Login(string email, string password, int pendingAttempts=3, CancellationToken ct=default) → Task- 役割
- ストアの顧客アカウントでログインし、短期の本人確認アサーションを取得して公式認可 SDK を起動します。
- 引数の説明
email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。pendingAttempts: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Task業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application.Restore
Restore(CancellationToken ct=default) → Task<bool>- 役割
- 保存済みセッションを読み込み、オンラインでアカウントを確認し、新しいアサーションを取得して公式 SDK を起動します。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Task<bool>true は復元成功、false は復元できるセッションがない状態です。拒否、期限切れ、通信失敗はエラーになります。
Application.RunFeature
RunFeature(string feature, Func<Task> action) → Task- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
Task業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application.Status
Status() → AuthorizationStatus? (null: runtime absent)- 役割
- 公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
- 戻り値
AuthorizationStatus? (null: runtime absent)公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
Application.Logout
Logout(CancellationToken ct=default) → Task- 役割
- ローカル認可を停止し、公式 SDK をログアウトしてから Launch セッションを無効化します。未完了のリモート処理は再試行用に保持します。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Task業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application.ReleaseDevice
ReleaseDevice(CancellationToken ct=default) → Task- 役割
- 明示的ログアウトの互換入口で、Logout と同じアカウントおよびデバイスのログアウト処理を行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Task業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application.DisposeAsync
DisposeAsync() → ValueTask- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
ValueTask業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
高度な API と互換 API
Application
Application(string origin, string productId, Config productConfig, string environment="live", ISessionStore? store=null, string? cacheDirectory=null, HttpMessageHandler? handler=null, Func<Config,IRuntime>? runtimeFactory=null) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productId: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。productConfig: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application.FromFiles
Application.FromFiles(string launchPath, string productPath, ISessionStore? store=null) → Application- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
launchPath, productPath: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。store: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
MemoryStore
new MemoryStore() → MemoryStore- 役割
- 現在のプロセス内だけで有効なセッションストレージを作成します。
- 戻り値
MemoryStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
WindowsDPAPIStore
new WindowsDPAPIStore(string? directory=null) → WindowsDPAPIStore- 役割
- 保護された永続セッションストレージを作成します。暗号鍵は OS の資格情報保管庫から取得してください。
- 引数の説明
directory: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
WindowsDPAPIStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
LaunchException
new LaunchException(string code, int status=0, int retryAfterSeconds=0) → LaunchException- 役割
- 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 引数の説明
code, status, retryAfterSeconds: 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
LaunchExceptionシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
ISessionStore.Load / MemoryStore.Load / WindowsDPAPIStore.Load
Load(string key) → byte[]?- 役割
- 分離キーでアカウント記録を読み込みます。機密データを含むため SDK にだけ渡してください。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
byte[]?機密記録を返します。存在しない場合は言語ごとの規約に従い空値または ErrNoSession になります。
ISessionStore.Save / MemoryStore.Save / WindowsDPAPIStore.Save
Save(string key, byte[] value) → void- 役割
- 分離キーを使ってアカウント記録をアトミックに保存します。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
ISessionStore.Delete / MemoryStore.Delete / WindowsDPAPIStore.Delete
Delete(string key) → void- 役割
- 指定のアカウント記録を削除します。公式 SDK の認可キャッシュやログアウトジャーナルは削除しません。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
IRuntime.Start
Start(CancellationToken ct) → Task- 役割
- 公式 SDK の検証とバックグラウンド保守を開始します。アカウントログインと機能保護は別の API で行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Task業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
IRuntime.Status
Status() → AuthorizationStatus- 役割
- 公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
- 戻り値
AuthorizationStatus公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
IRuntime.RunFeature
RunFeature(string feature, Func<Task> action) → Task- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
Task業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
IRuntime.Deactivate
Deactivate(CancellationToken ct) → Task- 役割
- 公式 SDK のデバイスログアウトを行います。Launch セッションの無効化はアプリ側で別途行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Task業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
IRuntime.DisposeAsync
DisposeAsync() → ValueTask- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
ValueTask業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
Java
対応するソース · v0.1.6 · Launch.java · EncryptedFileStore.java
エラーと失敗時の処理: throws Exception; Launch.Failure.code / .status / .requestID / .retryAfterMillis / .transport; char[] password
Launch.connect
Launch.connect(String merchantOrigin, String productId, String licentivoProductId, Map<String,String> trustedKeys, String environment) → Launch- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。trustedKeys / trusted_keys: 署名鍵 ID と公開鍵の対応表で、公式 SDK の署名済み認可を検証します。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。
- 戻り値
Launch作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Launch.login
login(String email, char[] password) → State- 役割
- ストアの顧客アカウントでログインし、短期の本人確認アサーションを取得して公式認可 SDK を起動します。
- 引数の説明
email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。
- 戻り値
Stateアカウント状態を返します。各フィールドは下の戻り値表を参照してください。
Launch.restore
restore() → State- 役割
- 保存済みセッションを読み込み、オンラインでアカウントを確認し、新しいアサーションを取得して公式 SDK を起動します。
- 戻り値
Stateアカウント状態を返します。ErrNoSession または NO_SESSION は保存セッションなしを示します。他のエラーは区別してください。
Launch.runFeature
runFeature(String feature, Client.FeatureAction action) → void- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Launch.logout
logout() → void- 役割
- ローカル認可を停止し、公式 SDK をログアウトしてから Launch セッションを無効化します。未完了のリモート処理は再試行用に保持します。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Launch.releaseDevice
releaseDevice() → void- 役割
- 明示的ログアウトの互換入口で、Logout と同じアカウントおよびデバイスのログアウト処理を行います。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Launch.close
close() → void- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
void業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
高度な API と互換 API
Launch
new Launch(Config config, Map<String,Object> product, Path cacheRoot [, Store store, Transport transport, RuntimeFactory factory, Sleeper sleeper]) → Launch- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
config, product: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。cacheRoot: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。store, transport, factory, sleeper: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Launch作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Launch.Config
new Launch.Config(String merchantOrigin, String launchProductID, String licentivoProductID, String environment) → Config- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。
- 戻り値
Configシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
Launch.Config.load
Launch.Config.load(Path path) → Config- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
path: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
Configシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
Launch.readPublic
Launch.readPublic(Path path) → Map<String,Object>- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
path: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
Map<String,Object>シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
Launch.MemoryStore
new Launch.MemoryStore() → MemoryStore- 役割
- 現在のプロセス内だけで有効なセッションストレージを作成します。
- 戻り値
MemoryStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
EncryptedFileStore
new EncryptedFileStore(Path directory, SecretKey vaultKey) → EncryptedFileStore- 役割
- 保護された永続セッションストレージを作成します。暗号鍵は OS の資格情報保管庫から取得してください。
- 引数の説明
directory: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。vaultKey: OS の資格情報保管庫から取得した暗号鍵です。暗号化した記録と一緒に保存しないでください。
- 戻り値
EncryptedFileStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Launch.HTTPTransport.request
request(String method, URI uri, String bearer, byte[] body) → Response- 役割
- アカウントの HTTP リクエストを送信し、ステータス、ヘッダー、生の本文を返します。認可判断は行いません。
- 引数の説明
method, uri, bearer, body: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
Responseシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
Launch.Failure
new Launch.Failure(String code [, int status, String requestID, long retryAfterMillis, boolean transport]) → Failure- 役割
- 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 引数の説明
code, status, requestID, retryAfterMillis, transport: 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
Failureシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
Launch.Failure.unavailable
unavailable() → boolean- 役割
- 一時的なサービス停止かを判定します。この判定だけでオフライン認可は許可されません。
- 戻り値
boolean真偽値による分類を返します。認可許可ではありません。
Store.load / MemoryStore.load / EncryptedFileStore.load
load(String scope) → byte[] | null- 役割
- 分離キーでアカウント記録を読み込みます。機密データを含むため SDK にだけ渡してください。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
byte[] | null機密記録を返します。存在しない場合は言語ごとの規約に従い空値または ErrNoSession になります。
Store.save / MemoryStore.save / EncryptedFileStore.save
save(String scope, byte[] secret) → void- 役割
- 分離キーを使ってアカウント記録をアトミックに保存します。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Store.delete / MemoryStore.delete / EncryptedFileStore.delete
delete(String scope) → void- 役割
- 指定のアカウント記録を削除します。公式 SDK の認可キャッシュやログアウトジャーナルは削除しません。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.canStartOffline
canStartOffline() → boolean- 役割
- 公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
- 戻り値
boolean真偽値による分類を返します。認可許可ではありません。
Runtime.start
start() → void- 役割
- 公式 SDK の検証とバックグラウンド保守を開始します。アカウントログインと機能保護は別の API で行います。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.runFeature
runFeature(String feature, Client.FeatureAction action) → void- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.releaseDevice
releaseDevice() → void- 役割
- 公式 SDK のデバイスログアウトを行います。Launch セッションの無効化はアプリ側で別途行います。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.close
close() → void- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
void業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
RuntimeFactory.create
create(Map<String,Object> settings) → Runtime- 役割
- 高度な連携向けに公式 SDK アダプターを作成します。本人確認アサーションはメモリ内だけで渡します。
- 引数の説明
settings: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
Runtime作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Sleeper.sleep
sleep(long milliseconds) → void- 役割
- 高度な再試行制御向けに、指定した時間だけ待機します。
- 引数の説明
milliseconds: 再試行までの推奨待機時間です。秒、ミリ秒、Duration の言語差に注意してください。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
JavaScript / TypeScript
対応するソース · v0.1.6 · index.d.ts · index.mjs
エラーと失敗時の処理: await Promise; catch (error); LaunchError(code, status, retryAfterSeconds)
Application.connect
Application.connect(merchantOrigin, productID, licentivoProductID, trustedKeys, options?) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。trustedKeys / trusted_keys: 署名鍵 ID と公開鍵の対応表で、公式 SDK の署名済み認可を検証します。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application.login
login(email: string, password: string, options?: {signal?: AbortSignal}) → Promise<SessionState>- 役割
- ストアの顧客アカウントでログインし、短期の本人確認アサーションを取得して公式認可 SDK を起動します。
- 引数の説明
email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Promise<SessionState>アカウント状態を返します。各フィールドは下の戻り値表を参照してください。
Application.restore
restore(options?: {signal?: AbortSignal}) → Promise<SessionState | null>- 役割
- 保存済みセッションを読み込み、オンラインでアカウントを確認し、新しいアサーションを取得して公式 SDK を起動します。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Promise<SessionState | null>アカウント状態を返します。null または nil は復元できるセッションがない状態です。その他の失敗はエラーになります。
Application.runFeature
runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
Promise<T>業務コールバックの結果を返します。認可失敗や業務例外はエラーとして通知します。
Application.logout
logout(options?: {signal?: AbortSignal}) → Promise<boolean>- 役割
- ローカル認可を停止し、公式 SDK をログアウトしてから Launch セッションを無効化します。未完了のリモート処理は再試行用に保持します。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Promise<boolean>true はログアウト確認済み、false はリモートのアカウント終了またはデバイス失効が保留中です。保存エラーが発生する場合もあります。
Application.releaseDevice
releaseDevice(options?: {signal?: AbortSignal}) → Promise<void>- 役割
- 明示的ログアウトの互換入口で、Logout と同じアカウントおよびデバイスのログアウト処理を行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Promise<void>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application.close
close() → Promise<void>- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
Promise<void>業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
高度な API と互換 API
Application
new Application(launch: LaunchConfig, product: PublicProductConfig, options?: Options) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
launch, product: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application.fromFiles
Application.fromFiles(launchPath: string, productPath: string, options?: Options) → Promise<Application>- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
launchPath, productPath: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Promise<Application>作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
validateConfig
validateConfig(launch: LaunchConfig, product: PublicProductConfig) → {launch: LaunchConfig, product: PublicProductConfig}- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
launch, product: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
{launch: LaunchConfig, product: PublicProductConfig}シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
loadConfig
loadConfig(launchPath: string, productPath: string) → Promise<{launch: LaunchConfig, product: PublicProductConfig}>- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
launchPath, productPath: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
Promise<{launch: LaunchConfig, product: PublicProductConfig}>シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
defaultTransport
defaultTransport(request: Request) → Promise<Response>- 役割
- アカウントの HTTP リクエストを送信し、ステータス、ヘッダー、生の本文を返します。認可判断は行いません。
- 引数の説明
request: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
Promise<Response>シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
MemoryStore
new MemoryStore() → MemoryStore- 役割
- 現在のプロセス内だけで有効なセッションストレージを作成します。
- 戻り値
MemoryStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
EncryptedFileStore
new EncryptedFileStore(directory: string, key: Uint8Array) → EncryptedFileStore- 役割
- 保護された永続セッションストレージを作成します。暗号鍵は OS の資格情報保管庫から取得してください。
- 引数の説明
directory: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。key: OS の資格情報保管庫から取得した暗号鍵です。暗号化した記録と一緒に保存しないでください。
- 戻り値
EncryptedFileStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
LaunchError
new LaunchError(code: string, status=0, retryAfterSeconds=0) → LaunchError- 役割
- 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 引数の説明
code, status, retryAfterSeconds: 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
LaunchErrorシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
SessionStore.load / MemoryStore.load / EncryptedFileStore.load
load(scope: string) → Promise<SavedSession | null>- 役割
- 分離キーでアカウント記録を読み込みます。機密データを含むため SDK にだけ渡してください。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Promise<SavedSession | null>機密記録を返します。存在しない場合は言語ごとの規約に従い空値または ErrNoSession になります。
SessionStore.save / MemoryStore.save / EncryptedFileStore.save
save(scope: string, value: SavedSession) → Promise<void>- 役割
- 分離キーを使ってアカウント記録をアトミックに保存します。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Promise<void>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
SessionStore.delete / MemoryStore.delete / EncryptedFileStore.delete
delete(scope: string) → Promise<void>- 役割
- 指定のアカウント記録を削除します。公式 SDK の認可キャッシュやログアウトジャーナルは削除しません。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Promise<void>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.status
status() → {allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>- 役割
- 公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
- 戻り値
{allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
Runtime.start
start(onError?: (error: unknown) => void, signal?: AbortSignal) → Promise<unknown>- 役割
- 公式 SDK の検証とバックグラウンド保守を開始します。アカウントログインと機能保護は別の API で行います。
- 引数の説明
onError: 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Promise<unknown>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.runFeature
runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
Promise<T>業務コールバックの結果を返します。認可失敗や業務例外はエラーとして通知します。
Runtime.deactivate
deactivate(signal?: AbortSignal) → Promise<unknown>- 役割
- 公式 SDK のデバイスログアウトを行います。Launch セッションの無効化はアプリ側で別途行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Promise<unknown>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime.logout
logout?(signal?: AbortSignal) → Promise<{local_complete:boolean,revocation_pending:boolean,storage_error?:string}>- 役割
- 公式 SDK のデバイスログアウトを行います。Launch セッションの無効化はアプリ側で別途行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Promise<{local_complete:boolean,revocation_pending:boolean,storage_error?:string}>ローカルのログアウトとリモート失効は別の状態です。保留や保存失敗を処理し、SDK のログアウトジャーナルを保持してください。
Runtime.close
close() → Promise<unknown>- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
Promise<unknown>業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
Rust
対応するソース · v0.1.6 · lib.rs · store.rs · transport.rs
エラーと失敗時の処理: Result<T, Failure>: Ok(value) / Err(Failure {code, status, request_id, retry_after, transport})
Application::connect
Application::connect(origin: &str, product_id: &str, licentivo_product_id: &str, trusted_keys: &[(&str,&str)], environment: &str) → Result<Application, Failure>- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。trustedKeys / trusted_keys: 署名鍵 ID と公開鍵の対応表で、公式 SDK の署名済み認可を検証します。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。
- 戻り値
Result<Application, Failure>作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application::login
login(&mut self, email: &str, password: &str) → Result<State, Failure>- 役割
- ストアの顧客アカウントでログインし、短期の本人確認アサーションを取得して公式認可 SDK を起動します。
- 引数の説明
email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。
- 戻り値
Result<State, Failure>アカウント状態を返します。各フィールドは下の戻り値表を参照してください。
Application::restore
restore(&mut self) → Result<State, Failure>- 役割
- 保存済みセッションを読み込み、オンラインでアカウントを確認し、新しいアサーションを取得して公式 SDK を起動します。
- 戻り値
Result<State, Failure>アカウント状態を返します。ErrNoSession または NO_SESSION は保存セッションなしを示します。他のエラーは区別してください。
Application::run_feature
run_feature<T,F: FnOnce() -> Result<T,Failure>>(&mut self, feature: &str, action: F) → Result<T, Failure>- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
Result<T, Failure>業務コールバックの結果を返します。認可失敗や業務例外はエラーとして通知します。
Application::logout
logout(&mut self) → Result<(), Failure>- 役割
- ローカル認可を停止し、公式 SDK をログアウトしてから Launch セッションを無効化します。未完了のリモート処理は再試行用に保持します。
- 戻り値
Result<(), Failure>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application::release_device
release_device(&mut self) → Result<(), Failure>- 役割
- 明示的ログアウトの互換入口で、Logout と同じアカウントおよびデバイスのログアウト処理を行います。
- 戻り値
Result<(), Failure>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application::close / Drop
close(&mut self) / drop(&mut self) → ()- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
()業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
高度な API と互換 API
Application::new
Application::new(config: Config, product: Value, cache_root: PathBuf) → Result<Application, Failure>- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
config, product: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。cache_root: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
Result<Application, Failure>作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application::with_components
Application::with_components(config: Config, product: Value, cache_root: PathBuf, store: Box<dyn Store>, transport: Box<dyn Transport>, factory: Box<dyn RuntimeFactory>, sleeper: Box<dyn Sleeper>) → Result<Application, Failure>- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
config, product: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。cache_root: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。store, transport, factory, sleeper: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Result<Application, Failure>作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Config::new
Config::new(origin: &str, product: &str, runtime_product: &str, environment: &str) → Result<Config, Failure>- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。
- 戻り値
Result<Config, Failure>シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
Config::load
Config::load(path: impl AsRef<Path>) → Result<Config, Failure>- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
path: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
Result<Config, Failure>シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
read_public
read_public(path: impl AsRef<Path>) → Result<Value, Failure>- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
path: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
Result<Value, Failure>シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
MemoryStore::default
MemoryStore::default() → MemoryStore- 役割
- 現在のプロセス内だけで有効なセッションストレージを作成します。
- 戻り値
MemoryStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
EncryptedFileStore::new
EncryptedFileStore::new(root: PathBuf, vault_key: [u8;32]) → Result<EncryptedFileStore, Failure>- 役割
- 保護された永続セッションストレージを作成します。暗号鍵は OS の資格情報保管庫から取得してください。
- 引数の説明
root: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。vault_key: OS の資格情報保管庫から取得した暗号鍵です。暗号化した記録と一緒に保存しないでください。
- 戻り値
Result<EncryptedFileStore, Failure>作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
CurlTransport::new
CurlTransport::new() → Result<CurlTransport, Failure>- 役割
- アカウントの HTTP リクエストを送信し、ステータス、ヘッダー、生の本文を返します。認可判断は行いません。
- 戻り値
Result<CurlTransport, Failure>作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
CurlTransport::request
request(&mut self, method: &str, url: &str, bearer: &str, body: &[u8]) → Result<Response, Failure>- 役割
- アカウントの HTTP リクエストを送信し、ステータス、ヘッダー、生の本文を返します。認可判断は行いません。
- 引数の説明
method, url, bearer, body: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
Result<Response, Failure>シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
Failure::new
Failure::new(code: &str) → Failure- 役割
- 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 引数の説明
code: 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
Failureシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
ThreadSleeper::sleep
sleep(&mut self, duration: Duration) → Result<(), Failure>- 役割
- 高度な再試行制御向けに、指定した時間だけ待機します。
- 引数の説明
duration: 再試行までの推奨待機時間です。秒、ミリ秒、Duration の言語差に注意してください。
- 戻り値
Result<(), Failure>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Store::load / MemoryStore::load / EncryptedFileStore::load
load(&mut self, scope: &str) → Result<Option<Vec<u8>>, Failure>- 役割
- 分離キーでアカウント記録を読み込みます。機密データを含むため SDK にだけ渡してください。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Result<Option<Vec<u8>>, Failure>機密記録を返します。存在しない場合は言語ごとの規約に従い空値または ErrNoSession になります。
Store::save / MemoryStore::save / EncryptedFileStore::save
save(&mut self, scope: &str, value: &[u8]) → Result<(), Failure>- 役割
- 分離キーを使ってアカウント記録をアトミックに保存します。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Result<(), Failure>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Store::delete / MemoryStore::delete / EncryptedFileStore::delete
delete(&mut self, scope: &str) → Result<(), Failure>- 役割
- 指定のアカウント記録を削除します。公式 SDK の認可キャッシュやログアウトジャーナルは削除しません。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Result<(), Failure>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime::run_feature
run_feature(&mut self, feature: &str, action: &mut dyn FnMut() -> Result<(),Failure>) → Result<(), Failure>- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
Result<(), Failure>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime::release_device
release_device(&mut self) → Result<(), Failure>- 役割
- 公式 SDK のデバイスログアウトを行います。Launch セッションの無効化はアプリ側で別途行います。
- 戻り値
Result<(), Failure>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Runtime::close
close(&mut self) → ()- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
()業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
RuntimeFactory::open / OfficialRuntimeFactory::open
open(&mut self, settings: &Value, cached_only: bool) → Result<Box<dyn Runtime>, Failure>- 役割
- 高度な連携向けに公式 SDK アダプターを作成します。本人確認アサーションはメモリ内だけで渡します。
- 引数の説明
settings, cached_only: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
Result<Box<dyn Runtime>, Failure>作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
RuntimeFactory::for_logout / OfficialRuntimeFactory::for_logout
for_logout(&mut self, settings: &Value) → Result<Box<dyn Runtime>, Failure>- 役割
- 高度な連携向けに公式 SDK アダプターを作成します。本人確認アサーションはメモリ内だけで渡します。
- 引数の説明
settings: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
Result<Box<dyn Runtime>, Failure>作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Sleeper::sleep
sleep(&mut self, duration: Duration) → Result<(), Failure>- 役割
- 高度な再試行制御向けに、指定した時間だけ待機します。
- 引数の説明
duration: 再試行までの推奨待機時間です。秒、ミリ秒、Duration の言語差に注意してください。
- 戻り値
Result<(), Failure>業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Ruby
対応するソース · v0.1.6 · licentivo_launch.rb
エラーと失敗時の処理: rescue LicentivoLaunch::Error; code / status / retry_after_seconds; callback exceptions
Application.connect
LicentivoLaunch::Application.connect(merchant_origin, product_id, licentivo_product_id, trusted_keys, environment: "live", **options) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。trustedKeys / trusted_keys: 署名鍵 ID と公開鍵の対応表で、公式 SDK の署名済み認可を検証します。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application#login
login(email, password, cancellation: nil) → Hash- 役割
- ストアの顧客アカウントでログインし、短期の本人確認アサーションを取得して公式認可 SDK を起動します。
- 引数の説明
email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Hashアカウント状態を返します。各フィールドは下の戻り値表を参照してください。
Application#restore
restore(cancellation: nil) → Hash | nil- 役割
- 保存済みセッションを読み込み、オンラインでアカウントを確認し、新しいアサーションを取得して公式 SDK を起動します。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
Hash | nilアカウント状態を返します。null または nil は復元できるセッションがない状態です。その他の失敗はエラーになります。
Application#run_feature
run_feature(feature) { ... } → T- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
T業務コールバックの結果を返します。認可失敗や業務例外はエラーとして通知します。
Application#logout
logout(cancellation: nil) → true | false- 役割
- ローカル認可を停止し、公式 SDK をログアウトしてから Launch セッションを無効化します。未完了のリモート処理は再試行用に保持します。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
true | falsetrue はログアウト確認済み、false はリモートのアカウント終了またはデバイス失効が保留中です。保存エラーが発生する場合もあります。
Application#release_device
release_device(cancellation: nil) → true | false- 役割
- 明示的ログアウトの互換入口で、Logout と同じアカウントおよびデバイスのログアウト処理を行います。
- 引数の説明
ctx / ct / signal / cancellation: リクエストコンテキストまたはキャンセル信号です。Go のライフサイクルコンテキストはバックグラウンド処理にも使います。
- 戻り値
true | falsetrue はログアウト確認済み、false はリモートのアカウント終了またはデバイス失効が保留中です。保存エラーが発生する場合もあります。
Application#close
close → nil- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
nil業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
高度な API と互換 API
Application.new
Application.new(launch, product, store: MemoryStore.new, transport: nil, runtime_factory: nil, cache_dir: nil, sleep: nil, pending_attempts: 5) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
launch, product: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application.from_files
Application.from_files(launch_path, product_path, **options) → Application- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
launchPath, productPath: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。options / config: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
LicentivoLaunch.origin
LicentivoLaunch.origin(value, environment) → String- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
value: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。
- 戻り値
Stringシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
LicentivoLaunch.validate_config
LicentivoLaunch.validate_config(launch, product) → [Hash, Hash]- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
launch, product: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
[Hash, Hash]シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
LicentivoLaunch.load_config
LicentivoLaunch.load_config(launch_path, product_path) → [Hash, Hash]- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
launchPath, productPath: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。
- 戻り値
[Hash, Hash]シグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
LicentivoLaunch.default_transport
LicentivoLaunch.default_transport(request) → Hash- 役割
- アカウントの HTTP リクエストを送信し、ステータス、ヘッダー、生の本文を返します。認可判断は行いません。
- 引数の説明
request: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
Hashシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
MemoryStore.new
MemoryStore.new → MemoryStore- 役割
- 現在のプロセス内だけで有効なセッションストレージを作成します。
- 戻り値
MemoryStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
EncryptedFileStore.new
EncryptedFileStore.new(directory, key) → EncryptedFileStore- 役割
- 保護された永続セッションストレージを作成します。暗号鍵は OS の資格情報保管庫から取得してください。
- 引数の説明
directory: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。key: OS の資格情報保管庫から取得した暗号鍵です。暗号化した記録と一緒に保存しないでください。
- 戻り値
EncryptedFileStore作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
MemoryStore#persistent? / EncryptedFileStore#persistent? / #secure?
persistent? / secure? → true | false- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 戻り値
true | false真偽値による分類を返します。認可許可ではありません。
EncryptedFileStore#path
path(scope) → String- 役割
- 公開設定を検証または読み込みます。製品 ID、環境、署名公開鍵が一致している必要があります。
- 引数の説明
scope: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Stringシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
CancellationToken#cancel / #check!
CancellationToken.new.cancel / check! → true / nil- 役割
- 協調的キャンセルを要求または確認します。キャンセルは認可成功を意味しません。
- 戻り値
true / nil業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Error.new
Error.new(code, status: 0, retry_after_seconds: 0) → Error- 役割
- 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 引数の説明
code, status, retry_after_seconds: 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
Errorシグネチャに示す型の値を返します。戻り値自体は機能の利用権限を与えません。
MemoryStore#load / EncryptedFileStore#load
load(scope) → Hash | nil- 役割
- 分離キーでアカウント記録を読み込みます。機密データを含むため SDK にだけ渡してください。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Hash | nil機密記録を返します。存在しない場合は言語ごとの規約に従い空値または ErrNoSession になります。
MemoryStore#save / EncryptedFileStore#save
save(scope, record) → Object- 役割
- 分離キーを使ってアカウント記録をアトミックに保存します。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Object業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
MemoryStore#delete / EncryptedFileStore#delete
delete(scope) → Object- 役割
- 指定のアカウント記録を削除します。公式 SDK の認可キャッシュやログアウトジャーナルは削除しません。
- 引数の説明
scope / key, value / record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
Object業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
C
対応するソース · v0.1.6 · account.h · account.c
エラーと失敗時の処理: NULL / 0 / -1; launch_application_error(app); action(context): 1=success, 0=failure
launch_application_connect
launch_application_connect(origin, product_id, licentivo_product_id, trusted_keys_json, environment, remember, store) → launch_application *- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。trustedKeys / trusted_keys: 署名鍵 ID と公開鍵の対応表で、公式 SDK の署名済み認可を検証します。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。remember, store: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
launch_application *所有権を持つアプリケーションポインターを返します。NULL は初期化失敗です。最後に close で解放します。
launch_application_login
launch_application_login(launch_application *app, const char *email, const char *password) → int- 役割
- ストアの顧客アカウントでログインし、短期の本人確認アサーションを取得して公式認可 SDK を起動します。
- 引数の説明
email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。
- 戻り値
int1 は成功、0 は失敗です。失敗後はエラーコードを確認します。
launch_application_restore
launch_application_restore(launch_application *app) → int- 役割
- 保存済みセッションを読み込み、オンラインでアカウントを確認し、新しいアサーションを取得して公式 SDK を起動します。
- 戻り値
int1 は復元成功、0 はセッションなし、-1 は拒否または失敗です。失敗後はエラーコードを確認します。
launch_application_run_feature
launch_application_run_feature(app, feature, ln_feature_action action, void *context) → int- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。context: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
int1 は成功、0 は失敗です。失敗後はエラーコードを確認します。
launch_application_logout
launch_application_logout(launch_application *app) → int- 役割
- ローカル認可を停止し、公式 SDK をログアウトしてから Launch セッションを無効化します。未完了のリモート処理は再試行用に保持します。
- 戻り値
int1 は成功、0 は失敗です。失敗後はエラーコードを確認します。
launch_application_release_device
launch_application_release_device(launch_application *app) → int- 役割
- 明示的ログアウトの互換入口で、Logout と同じアカウントおよびデバイスのログアウト処理を行います。
- 戻り値
int1 は成功、0 は失敗です。失敗後はエラーコードを確認します。
launch_application_status
launch_application_status(launch_application *app) → char *- 役割
- 公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
- 戻り値
char *所有権を持つ JSON 文字列を返します。ln_free_string で解放します。ランタイムがない場合は login_required と allowed=false です。
launch_application_error
launch_application_error(const launch_application *app) → const char *- 役割
- 分類、待機、リクエストの追跡に使う構造化エラーを作成または取得します。
- 戻り値
const char *借用したエラーコード文字列を返します。解放せず、アプリケーション破棄後は参照しないでください。
launch_application_close
launch_application_close(launch_application *app) → void- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
void業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
高度な API と互換 API
launch_application_open
launch_application_open(origin, product_id, product_config_path, environment, remember, store) → launch_application *- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。product_config_path: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。remember, store: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
launch_application *所有権を持つアプリケーションポインターを返します。NULL は初期化失敗です。最後に close で解放します。
launch_application_from_files
launch_application_from_files(launch_config_path, product_config_path, remember, store) → launch_application *- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
launchPath, productPath: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。remember, store: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
launch_application *所有権を持つアプリケーションポインターを返します。NULL は初期化失敗です。最後に close で解放します。
launch_application_cli
launch_application_cli(int argc, char **argv) → launch_application *- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
argc, argv: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
launch_application *所有権を持つアプリケーションポインターを返します。NULL は初期化失敗です。最後に close で解放します。
launch_login / launch_sign_in
launch_login(account, origin, product_id, config_path, environment, email, password) / launch_sign_in(account, argc, argv) → int- 役割
- 互換用の旧 API です。長期ライセンス資格情報の方式は廃止されているため失敗します。新規実装には Application を使います。
- 引数の説明
account, origin, product_id, config_path, environment, email, password, argc, argv: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
int常に失敗します。アカウント本人確認の交換 API へ移行してください。
launch_sign_out
launch_sign_out(launch_account *account, int clear_cache) → void- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 引数の説明
account, clear_cache: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
ln_free_string
ln_free_string(char *value) → void- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 引数の説明
value: 所有権を持つ JSON 文字列を返します。ln_free_string で解放します。ランタイムがない場合は login_required と allowed=false です。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
launch_secret_store.load
load(void *context, const char *scope, char **record) → int- 役割
- 分離キーでアカウント記録を読み込みます。機密データを含むため SDK にだけ渡してください。
- 引数の説明
context: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。scope, record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
int1 は記録あり、0 はなし、-1 は読み取り失敗です。load が record を確保し、呼び出し元が解放します。
launch_secret_store.save
save(void *context, const char *scope, const char *record) → int (1: success, 0: failure)- 役割
- 分離キーを使ってアカウント記録をアトミックに保存します。
- 引数の説明
context: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。scope, record: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
int (1: success, 0: failure)業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
launch_secret_store.remove
remove(void *context, const char *scope) → int (1: success, 0: failure)- 役割
- 指定のアカウント記録を削除します。公式 SDK の認可キャッシュやログアウトジャーナルは削除しません。
- 引数の説明
context: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。scope: SDK の分離キーと機密記録です。独自ストレージは複数キーとアトミックな置換をサポートしてください。
- 戻り値
int (1: success, 0: failure)業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
C++
対応するソース · v0.1.6 · launch.hpp
エラーと失敗時の処理: std::runtime_error; callback exceptions propagate; RAII; Status(): std::string JSON
Application::Connect
Application::Connect(origin, product, licentivo_product, trusted_keys_json, environment="live", remember=false, store=nullptr) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
merchantOrigin / origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。productID / product_id: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。licentivoProductID / licentivo_product_id: Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。trustedKeys / trusted_keys: 署名鍵 ID と公開鍵の対応表で、公式 SDK の署名済み認可を検証します。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。remember, store: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application::Login
Login(const char *email, const char *password) → void- 役割
- ストアの顧客アカウントでログインし、短期の本人確認アサーションを取得して公式認可 SDK を起動します。
- 引数の説明
email, password: このストアで登録した顧客のメールとパスワードです。パスワードは今回のログインだけに使います。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application::Restore
Restore() → bool- 役割
- 保存済みセッションを読み込み、オンラインでアカウントを確認し、新しいアサーションを取得して公式 SDK を起動します。
- 戻り値
booltrue は復元成功、false は復元できるセッションがない状態です。拒否、期限切れ、通信失敗はエラーになります。
Application::RunFeature
RunFeature(const char *feature, Action action) → void- 役割
- 実行のたびに公式 SDK が権限を確認し、許可された場合だけコールバックを実行します。
- 引数の説明
feature / name, action / block: 機能名はポリシーと一致させ、コールバックには実際の保護対象業務を入れます。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application::Logout
Logout() → void- 役割
- ローカル認可を停止し、公式 SDK をログアウトしてから Launch セッションを無効化します。未完了のリモート処理は再試行用に保持します。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application::ReleaseDevice
ReleaseDevice() → void- 役割
- 明示的ログアウトの互換入口で、Logout と同じアカウントおよびデバイスのログアウト処理を行います。
- 戻り値
void業務上の戻り値はありません。正常終了は成功、エラーや例外は失敗を示します。
Application::Status
Status() → std::string (JSON)- 役割
- 公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
- 戻り値
std::string (JSON)公式 SDK の現在の認可状態を読み取ります。ログインや機能実行時の権限確認の代わりにはなりません。
Application::~Application
~Application() → void- 役割
- 現在のインスタンスとバックグラウンド処理を停止し、記憶したログインとデバイスの関連付けを保持します。
- 戻り値
void業務上の戻り値はありません。通常終了をアカウントログアウトやデバイス解放の完了と扱わないでください。
高度な API と互換 API
Application
Application(origin, product, config, environment="live", remember=false, store=nullptr) → Application- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
origin: プロトコルと必要なポートを含む現在のストアのオリジンです。本番では HTTPS を使います。product: 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。config: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。environment: sandbox または live。アカウント、製品、キャッシュの環境を一致させます。remember, store: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application(launch_application *)
explicit Application(launch_application *app) → Application- 役割
- 公開設定を検証してアプリケーションを作成します。この時点ではログインも保護機能の許可も行いません。
- 引数の説明
app: 所有権を持つアプリケーションポインターを返します。NULL は初期化失敗です。最後に close で解放します。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application::FromFiles
Application::FromFiles(launch, product, remember=false, store=nullptr) → Application- 役割
- 既存の公開設定ファイルを二つ読み込み、製品の対応を検証してアプリを作成します。直接接続ではファイルは不要です。
- 引数の説明
launch, product: 呼び出し元が指定する設定パス、または現在のユーザー専用のキャッシュ・保存ディレクトリです。remember, store: セッション保存、プライベートキャッシュ、キャンセル、再試行、高度なコンポーネントのオプションです。
- 戻り値
Application作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
Application(Application&&) / operator=
Application(Application&& other) / operator=(Application&& other) → Application / Application&- 役割
- ネイティブアプリケーションの所有権を移動します。コピーは禁止され、元のオブジェクトはポインターを所有しなくなります。
- 引数の説明
other: 高度な連携でのみ提供する設定、ランタイムアダプター、トランスポート、リクエストのオブジェクトです。
- 戻り値
Application / Application&作成したオブジェクトを返します。初期化だけで認可が成立するわけではありません。
戻り値のフィールド
アカウント状態を返します。各フィールドは下の戻り値表を参照してください。
| フィールド | 種類 | 役割 |
|---|---|---|
Go State.User.ID · JS user.id · Java userID · Rust user_id · Ruby user.id | string | ストアアカウントの一意な ID です。製品、ライセンス、デバイスの ID ではありません。 |
Go User.Email · JS user.email · Java/Rust/Ruby email | string | ストアアカウントのメールです。言語によっては状態にアカウント ID だけを含みます。 |
Go User.Verified / user.verified | boolean | ストアのメールが確認済みかを示します。ソフトウェアの認可状態ではありません。 |
JS user.display_name | string (optional) | ストアアカウントの表示名です。サーバーが返さない場合は省略されます。 |
Go State/Session.ExpiresAt · JS expiresAt · Java expiresAt · Rust/Ruby expires_at | time.Time / ISO 8601 / Instant | Launch アカウントセッションの期限です。購入期限やオフライン認可期限ではありません。 |
Java offlineFallback · Rust offline_fallback | boolean = false | 互換フィールドです。現在の復元はオフラインへの切り替えを選ばないため false です。 |
C / C++ status.allowed · C# Status().Allowed | boolean | 公式 SDK が現在利用を許可しているかを示します。個々の機能は別途ガードします。 |
C / C++ status.state · C# Status().State | string | 公式 SDK の状態名です。未ログイン時は login_required の場合があります。 |
C / C++ status.code · C# Status().Code | string | 表示や処理分岐に使う、機械処理可能で安定したエラーコードです。 |
C / C++ status.request_id · C# Status().RequestID | string | 調査用のサーバーリクエスト追跡 ID です。公開しない言語もあります。 |
C / C++ status.retryable · C# Status().Retryable | boolean | 再試行が推奨されるかを示します。現在の保護機能の実行許可ではありません。 |
C / C++ status.lease_valid_until · C# Status().LeaseValidUntil | Unix seconds | 公式 SDK の署名済み認可の期限を Unix 秒で示します。アカウントセッション期限とは異なります。 |
Go Identity.ProductID / product_id | UUID | 管理画面の連携コードが自動入力する Launch ストアの製品 ID です。 |
Go Identity.LicentivoProductID / licentivo_product_id | UUID | Licentivo のライセンス製品 ID で、公開署名設定と一致する必要があります。 |
Go Identity.LaunchConnectionID / launch_connection_id | UUID | 固定された Launch 認可接続 ID です。製品と環境に一致する必要があります。 |
Go Identity.Environment / environment | sandbox | live | sandbox または live。アカウント、製品、キャッシュの環境を一致させます。 |
Go Identity.IdentityToken / identity_token | string | 短期で一度だけ使える本人確認アサーションです。公式 SDK にメモリ内で渡し、オフライン資格情報には使いません。 |
Go Identity.ExpiresAt / identity.expires_at | time.Time / ISO 8601 | 本人確認アサーションの期限です。アカウントセッションや購入の期限ではありません。 |
Go Session.AccessToken / access_token / token | string | Launch アカウントセッショントークンです。低レベルセッション API や暗号化ストレージだけが返します。 |
セッショントークン、アサーション、保存記録は秘密情報です。ログやブラウザーのレンダラーに渡さないでください。
エラーと失敗時の処理
| フィールド | 種類 | 役割 |
|---|---|---|
Go APIError.Code · Python APIError.code · C# Code · Java/Rust/Ruby code · JS code · C error() | string | 表示や処理分岐に使う、機械処理可能で安定したエラーコードです。 |
Go APIError.Status · Python status · C# Status · Java/Rust/Ruby/JS status | integer | HTTP ステータスです。0 は HTTP 応答がないことを示します。 |
Go RequestID · Java requestID · Rust request_id | string | 調査用のサーバーリクエスト追跡 ID です。公開しない言語もあります。 |
Go RetryAfter · Python retry_after · C# RetryAfterSeconds · Java retryAfterMillis · JS/Ruby retryAfterSeconds / retry_after_seconds · Rust retry_after | Duration / s / ms | 再試行までの推奨待機時間です。秒、ミリ秒、Duration の言語差に注意してください。 |
ローカルのログアウトとリモート失効は別の状態です。保留や保存失敗を処理し、SDK のログアウトジャーナルを保持してください。