モジュール：session

目次

機能

• getDevice
• getEntryPointAsync
• getEntryPointData
• getLocale
• getOrientation
• getPlatform
• getTrafficSource
• onOrientationChange
• setSessionData
• switchGameAsync
• isAudioEnabled
• onAudioStatusChange

機能

getDevice

▸ getDevice(): Device

プレーヤーが使用しているデバイスを取得します。こちらは、デバイス固有のコードを実装するのに便利です。

例

const device = Wortal.session.getDevice();
console.log(device);

Returns

Device

プレーヤーが使用しているデバイス。

---

getEntryPointAsync

▸ getEntryPointAsync(): Promise<string>

ゲームを開始したエントリーポイントを返します。

例

Wortal.session.getEntryPointAsync()
 .then(entryPoint => console.log(entryPoint));

Returns

Promise<string>

ユーザーがゲームを開始したエントリーポイント名を解決する Promise。

Throws

• NOT_SUPPORTED
• RETHROW_FROM_PLATFORM

---

getEntryPointData

▸ getEntryPointData(): Record<string, unknown>

ゲームを開始したエントリーポイントに関連するすべてのデータオブジェクトを返します。

オブジェクトの内容は開発者が決めるものであり、異なるプラットフォームのエントリーポイントから作成が可能。古いモバイルを持つクライアントや、特定のエントリーポイントに関連するデータがない場合は、 Null を返します。

例

let data = Wortal.session.getEntryPointData();
console.log(data.property);

Returns

Record<string, unknown>

エントリーポイントに関するデータ、または存在しない場合、空のオブジェクトを指します。

---

getLocale

▸ getLocale(): string

プレーヤーが使用しているロケールを取得します。これは、ゲームのローカライズに役立ちます。

例

let lang = Wortal.session.getLocale();

Returns

string

BCP47 形式のロケール。

---

getOrientation

▸ getOrientation(): Orientation

プレイヤーが使用しているデバイスの画面の向きを取得します。こちらは、ゲームの表示方法を決定するのに役立ちます。

例

const orientation = Wortal.session.getOrientation();
if (orientation === 'portrait') {
   // Render portrait mode.
}

Returns

Orientation

プレーヤーが使用しているデバイスの画面の向き。

---

getPlatform

▸ getPlatform(): Platform

ゲームを開始したプラットフォームを取得します。例えば、FacebookとLinkで異なるソーシャルシェアアセットを表示したい場合など、プラットフォーム固有のコードを実装するのに便利です。

例

let platform = Wortal.session.getPlatform();
console.log(platform);

Returns

Platform

ゲームを開始したプラットフォーム。

---

getTrafficSource

▸ getTrafficSource(): TrafficSource

ゲームのトラフィックソースを取得します。これは、プレイヤーがどこから動画を見つけたのか、流入経路を見つけるのに役立ちます。例えば、特定のキャンペーンでプレイヤーがどこから流入したかを確認したい場合などです。

例

let source = Wortal.session.getTrafficSource();
console.log(source['r_entrypoint']);
console.log(source['utm_source']);

Returns

TrafficSource

ゲームに付与するURL パラメータ。

---

onOrientationChange

▸ onOrientationChange(callback): void

デバイスの画面の向きが切り替わったときに呼び出されるコールバックを指定します。

例

Wortal.session.onOrientationChange(orientation => {
   if (orientation === 'portrait') {
     // Render portrait mode
   }
});

パラメーター

Name	Type	Description
callback	(orientation: Orientation) => void	デバイスの画面の向きが切り替わったときに呼び出されるコールバック

Returns

void

---

setSessionData

▸ setSessionData(data): void

現在のコンテキストの個々のゲームプレイセッションに関連するデータを設定します。

こちらは、ゲームが現在のセッションデータを更新したいときに呼び出せます。セッションデータは、ゲームプレイのウェブフックなど、さまざまなペイロードを送信するために使用することができます。

例

Wortal.session.setSessionData({
    'high-score': 100,
    'current-level': 2,
});

パラメーター

名前	タイプ	内容説明
data	Record<string, unknown>	任意のデータオブジェクトで、文字列は1000文字以下でなければならない。

Returns

void

---

switchGameAsync

▸ switchGameAsync(gameID, data?): Promise<void>

別のゲームへとゲームを切り替えるためのリクエスト。切り替えに失敗した場合、APIは拒否します。成功した場合、プレイヤーは新しいゲームをロードします。

例

Wortal.session.switchGameAsync(
  '12345678',
  { referrer: 'game_switch', reward_coins: 30 });

Parameters

Name	Type	Description
gameID	string	切り替えるゲームID。こちらの操作を行えるのは、Wortalゲームのみ。
data?	object	任意のペイロードデータ。こちらは、切り替え先のゲームのエントリポイントデータとして設定されます。最大文字数は1000文字以内でなければなりません。

Returns

Promise<void>

ゲームが切り替わったときに解決する Promise。ゲームが切り替わらなかった場合、Promise は拒否されます。

Throws

• INVALID_PARAMS
• USER_INPUT
• PENDING_REQUEST
• CLIENT_REQUIRES_UPDATE
• NOT_SUPPORTED

---

isAudioEnabled

▸ isAudioEnabled(): boolean

プレイヤーのオーディオが有効かどうかを返します。

例

if(Wortal.session.isAudioEnabled()){
  // 何かを行う
}

Returns

boolean オーディオが有効であれば true 、無効であれば false 。

---

onAudioStatusChange

▸ onAudioStatusChange(callback): void

プレイヤーのオーディオ状態が変更されたときに呼び出されるコールバックを設定します。

例

// オーディオ状態の変化を監視し、ゲームオーディオを調整
Wortal.session.onAudioStatusChange(isAudioEnabled => {
  // 例:
  if (isAudioEnabled) {
    GameAudioManager.unmute();
  } 
  else {
    GameAudioManager.mute();
  }
});

パラメーター

名前	タイプ	内容説明
callback	(isAudioEnabled: boolean) => void	プレイヤーのオーディオ状態が変更されたときに呼び出されるコールバック。

Returns

void