EloView Home SDK 6.23.14

サポートされているプラットフォーム: Android 12 および Android 14 のEloデバイス（Backpack 4（Standard/Value）、I-Series 4（Standard/Value）、I-Series Standard、M50、M60 Pay、M100、7インチPayを含む）。

完全なリファレンス (知識ベース + SDK Javadoc)

APIsは機能クラス（システム、ネットワーク、パッケージなど）によって整理されており、発見を簡素化し実装を加速します。

---

グローバルベストプラクティス (KBより)

1. APIを呼び出す前にサービスにバインドしてください。
   onServiceConnected() を受信するまでメソッドを呼び出さないでください。

2. デバイスポリシーがローカル設定を上書きできることを想定してください。
   これは特に時刻、タイムゾーン、USB、キオスクモード、アプリケーションのインストールに当てはまります。

3. 本番環境での時刻同期にNTPを使用してください。
   テスト以外の手動時刻設定は避けてください。

4. リセット動作を理解してください。

   • エンタープライズリセット はEloの設定と登録状態をクリアします。

   • 工場出荷時リセット はすべてのユーザーデータを消去し、デバイスを初期状態に戻します。

5. API呼び出しの結果をログに記録してください。
   これはトラブルシューティングとエスカレーションに重要です。

---

一般的な実際のシナリオ (KBより)

シナリオ: デバイス登録後のタイムゾーンが間違っている

system.setNtpEnabled(true);
system.setNtpServer("time.aws.com");
system.setTimeZone("US/Central");
system.syncTimeNow();

// 確認
String tz = system.getTimeZone();
Log.d(TAG, "Timezone=" + tz);

ヒント: リブート後にタイムゾーンが戻る場合、Androidの自動タイムゾーンが有効になっていること、およびデバイスポリシーが異なる地域を再適用していないことを確認してください。

シナリオ: 単一アプリキオスクモードを安全に構成する

pkg.setKioskApp("com.example.kiosk");
pkg.setKioskModeEnabled(true);
pkg.launchApp("com.example.kiosk");

警告: 本番環境でキオスクモードを有効にする前に、管理者脱出パスを常に検証してください。

サービスバインディングテンプレート (KBより)

eloView.bindService(context, callback, accessToken);
// callback.onServiceConnected()の中でSDK APIを呼び出すのは安全です
eloView.unbindService(context);

重要な注意: bindService() と unbindService() は 値を返しません。SDK APIは、onServiceConnected()が呼び出された後にのみ呼び出す必要があります。

コア / サービスバインディング APIs

EloView

EloView クラスは次の操作を提供します：

• デバイスがオフラインまたはアカウントに登録されていないときに setOfflinePlayContent()を使用して、EloView Control モードで再生されるコンテンツを設定します。
• 現在EloView Control モードに設定されているコンテンツのタイプ（APKまたはWebView）と名前を取得するには、 getPlayContent()を使用します。
• EloView Control モードで設定されたコンテンツの現在の再生状況を取得するには、getPlayContentStatus()を使用します。
• デバイスが現在EloView Cloud（オンラインまたはオフライン）に接続されているかを確認するには getDeviceCloudStatus()を使用します。
• Elo QuickSettingsおよびAndroid HomeモードでWi-Fiを切り替えるには toggleWifi()を使用します。
• Elo QuickSettingsおよびAndroid HomeモードでBluetoothを切り替えるには toggleBT()を使用します。

bindService

public void bindService(android.content.Context context, ServiceConnectionCallback callback, java.lang.String accessToken)

このメソッドは、EloViewサービスをアプリケーションにバインドします。これを呼び出す前に、EloView API を呼び出す必要があります。

パラメータ

• context – EloView APIを使用するコンテキスト。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.bindService(context, callback, "accessToken");
    Log.d(TAG, "OK: bindService result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: bindService", e);
}

unbindService

public void unbindService(android.content.Context context)

このメソッドはアプリケーションからサービスをアンバインドするために使用されます。リソースを解放するときにこのメソッドを使用してください。

パラメータ

• context – コンテキスト

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.unbindService(context);
    Log.d(TAG, "OK: unbindService result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: unbindService", e);
}

setOfflinePlayContent

public java.lang.String setOfflinePlayContent(java.lang.String packageName)

このメソッドは、デバイスがオフラインであるか、アカウントに登録されていないときにEloView Controlモードでのコンテンツを設定するために使用されます。 デバイスがオンラインになり、EloViewを介してコンテンツが設定されると、これはこのAPIを介して設定されたコンテンツを上書きします。

パラメータ

• packageName – デフォルトコンテンツとして設定するパッケージ。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.setOfflinePlayContent("packageName");
    Log.d(TAG, "OK: setOfflinePlayContent result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: setOfflinePlayContent", e);
}

getPlayContent

public java.lang.String getPlayContent()

このメソッドは、デバイスに設定されているコンテンツのタイプと名前を返します。 このメソッドは、EloView Control モードでのみ動作します。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getPlayContent();
    Log.d(TAG, "OK: getPlayContent result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getPlayContent", e);
}

getPlayContentStatus

public java.lang.String getPlayContentStatus()

このメソッドは、Control モードでのデバイス上の再生コンテンツのステータスを返します。 ステータスは以下の文字列のいずれかになります：

YET_TO_DOWNLOAD, DOWNLOADING, DOWNLOADED, INSTALLING, INSTALLED, DOWNLOAD_FAILED, INSTALL_FAILED, UNKNOWN_STATUS

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getPlayContentStatus();
    Log.d(TAG, "OK: getPlayContentStatus result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getPlayContentStatus", e);
}

getDeviceCloudStatus

public java.lang.String getDeviceCloudStatus()

このメソッドは、デバイスのオンラインまたはオフラインステータスを返します。ステータスは以下の文字列のいずれかになります： "オンライン"、"オフライン"、"接続中"、"再接続中"、"オンライン（プロビジョニングされていない）"。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getDeviceCloudStatus();
    Log.d(TAG, "OK: getDeviceCloudStatus result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getDeviceCloudStatus", e);
}

toggleWifi

void toggleWifi(boolean isEnableWifi)

デバイスのWi-Fiを有効または無効にします。これは、EloViewモードおよび Androidホームモードの両方に適用されます。

パラメータ

• isEnableWifi – QuickSettingsでWi-Fiを有効または無効にするためのブール値。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.toggleWifi(true);
    Log.d(TAG, "OK: toggleWifi result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: toggleWifi", e);
}

switchToAndroidHomeMode

void switchToAndroidHomeMode() void switchToAndroidHomeMode(boolean isRebootNeeded, boolean isAndroidHomeMode)

このメソッドは、EloViewモードからAndroidホームモードに切り替えるために使用されます。 これはswitchToAndroidHomeMode()と同じですが、2つのブールパラメータを受け入れます。 工場出荷時リセットなしにEloViewモードに戻る方法はないため、使用には注意が必要です。

パラメータ

• デバイスをEloViewモードからAndroidホームモードに切り替えます。
• isRebootNeededがtrueに設定されている場合、デバイスはモード変更を適用するために再起動します。
• 重要な注意: Androidホームモードへの切り替えは、EloViewが管理する制限やポリシーを無効にする可能性があります。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.switchToAndroidHomeMode(true, true);
    Log.d(TAG, "OK: switchToAndroidHomeMode result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: switchToAndroidHomeMode", e);
}

toggleBT

public int toggleBT(boolean isEnableBT)

このメソッドは、QuickSettings（EloViewモード）でBluetoothを切り替えるために使用されます。 また、AndroidホームモードでもBluetoothを切り替えるために使用できます。

パラメータ

• isEnableBT – QuickSettingsでBluetoothを有効または無効にするためのブール値。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.toggleBT(true);
    Log.d(TAG, "OK: toggleBT result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: toggleBT", e);
}

アカウント APIs

AccountManager

AccountManagerクラスは次の操作を提供します：

1. ユーザーが提供する資格情報（emailId/passwordまたはclientId/secretKey）に基づいて、EloServerから認証トークンを提供します。

2. 指定された認証トークンが有効かどうか、または期限切れであるかを検証します。認証トークンは、EloViewサーバーから取得したトークンであるか、Eloサポートチームが提供したオフラインJWTトークンである可能性があります（オフライントークンはアプリケーションのパッケージ名を使用して生成され、生成されたパッケージでのみ使用できます）。

3. すべてのAPIは機能するためにオフライントークンが必要であり、オンライントークンでは機能しません。唯一の例外はOTA APIです。OTA APIは、EloViewサーバーからOTAを適用する際にオンライントークンを必要とします。カスタムサーバーURLまたはデバイス上のローカルファイルからOTAを適用するために、オフライントークンを使用することができます。

認証トークンを取得するには、次の手順を行います：

1. emailIdとパスワードを使用してgetEloAccessTokenを呼び出します。 2. clientIdとsecretKeyを使用してgetEloOAuthTokenを呼び出します。認証が成功すると、これらのメソッドはトークンを返します。 3. オフラインJWTトークンについては、Eloサポートチームに連絡してください。

サーバーまたはサポートチームから取得したトークンは、verifyEloTokenメソッドを使用して検証されます。

これらのAccountManager APIを使用しているアクティビティのonPauseおよびonDestroyメソッドで、これらのブロードキャストレシーバーを解除登録します。これにより、リークを防ぐことができます。

getProperty

public static java.lang.String getProperty()

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getProperty();
    Log.d(TAG, "OK: getProperty result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getProperty", e);
}

setProperty

public void setProperty(java.lang.String property)

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.setProperty("property");
    Log.d(TAG, "OK: setProperty result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: setProperty", e);
}

getClientId

public static java.lang.String getClientId()

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getClientId();
    Log.d(TAG, "OK: getClientId result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getClientId", e);
}

getBaseUri

public static android.net.Uri getBaseUri()

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getBaseUri();
    Log.d(TAG, "OK: getBaseUri result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getBaseUri", e);
}

getEloAccessToken

public void getEloAccessToken(android.content.Context context, java.lang.String userEmail, java.lang.String password, android.os.Handler handler)

このメソッドは、Eloサーバーからアクセストークンを取得するために使用されます。

パラメータ

• context – 呼び出しクラス（ActivityまたはService）のコンテキストオブジェクト。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getEloAccessToken(context, "userEmail", "password", handler);
    Log.d(TAG, "OK: getEloAccessToken result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getEloAccessToken", e);
}

configureOAuthHostedUI

public void configureOAuthHostedUI(android.app.Activity activity, android.os.Handler handler)

このメソッドは、OAuth Hosted UIを初期化するために使用されます。

パラメータ

• activity – 呼び出しクラスのActivityインスタンス。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.configureOAuthHostedUI(activity, handler);
    Log.d(TAG, "OK: configureOAuthHostedUI result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: configureOAuthHostedUI", e);
}

stopOAuth

public void stopOAuth()

stopOAuthをアクティビティのonStop()オーバーライドメソッド内で呼び出します。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.stopOAuth();
    Log.d(TAG, "OK: stopOAuth result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: stopOAuth", e);
}

destroyOAuth

public void destroyOAuth()

destroyOAuthをアクティビティのonStop()オーバーライドメソッド内で呼び出します。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.destroyOAuth();
    Log.d(TAG, "OK: destroyOAuth result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: destroyOAuth", e);
}

logoutOAuth

public void logoutOAuth()

logoutOAuthを呼び出して、現在のログインセッションを終了します。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.logoutOAuth();
    Log.d(TAG, "OK: logoutOAuth result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: logoutOAuth", e);
}

verifyEloToken

public void verifyEloToken(android.content.Context context, java.lang.String accessToken, android.os.Handler handler)

この関数は、Eloサーバーに指定されたトークンを検証するように要求します。検証が成功した場合、ハンドラはTOKEN_VERIFY_SUCCESS型のメッセージを受け取ります。失敗した場合、TOKEN_VERIFY_FAILが受信されます。

パラメータ

• context – 呼び出しクラスのコンテキストオブジェクト（アクティビティまたはサービス）。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.verifyEloToken(context, "accessToken", handler);
    Log.d(TAG, "OK: verifyEloToken result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: verifyEloToken", e);
}

getEloOAuthToken

public void getEloOAuthToken(android.content.Context context, java.lang.String clientID, java.lang.String secret, android.os.Handler handler)

このメソッドは、EloViewポータルに新しいOAuthトークンを要求するために使用されます。認証が成功すると、トークンがデバイスに送信されます。このトークンは発行後24時間有効です。トークンが期限切れになると、トークンを検証してAPIを呼び出す試みはTOKEN_VERIFY_FAILレスポンスを受け取ります。トークンがまだ取得されていない場合も同様です。

成功した場合、ハンドラはJWTトークンをレスポンスとして含むOAUTH_TOKEN_VALID型のメッセージを受け取ります。 以下は成功したレスポンスの例です：

認証の失敗が不正なclientIDまたはsecretIDによって引き起こされた場合、ハンドラはOAUTH_TOKEN_INVALID型のメッセージを受け取ります。

パラメータ

• context – 呼び出しクラスのコンテキストオブジェクト（アクティビティまたはサービス）。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getEloOAuthToken(context, "clientID", "secret", handler);
    Log.d(TAG, "OK: getEloOAuthToken result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getEloOAuthToken", e);
}

unregisterAccountManagerListener

public void unregisterAccountManagerListener(android.content.Context context)

このメソッドは、AccountManager APIの使用中に登録されたブロードキャストレシーバーを解除登録するために使用されます。これらのAPIを使用した場合は、アクティビティのライフサイクル内のonPauseおよびonDestroyメソッドでこれを呼び出すことを確認してください。これにより、レシーバーがリークされないようにします。

パラメータ

• context – システムAPIが使用されたコンテキスト。
• context – アカウントマネージャリスナーを解除登録するために使用されるAndroidコンテキスト。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.unregisterAccountManagerListener(context);
    Log.d(TAG, "OK: unregisterAccountManagerListener result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: unregisterAccountManagerListener", e);
}

setDefaultEnvironment

public void setDefaultEnvironment(android.content.Context ctx)

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.setDefaultEnvironment(context);
    Log.d(TAG, "OK: setDefaultEnvironment result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: setDefaultEnvironment", e);
}

selectEnvironment

public void selectEnvironment(android.content.Context ctx, java.lang.String prop, boolean isSealed)

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.selectEnvironment(context, "prop", true);
    Log.d(TAG, "OK: selectEnvironment result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: selectEnvironment", e);
}

isPolarisLocked

public boolean isPolarisLocked(android.content.Context context)

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.isPolarisLocked(context);
    Log.d(TAG, "OK: isPolarisLocked result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: isPolarisLocked", e);
}

getEnvironment

public java.lang.String getEnvironment(android.content.Context ctx)

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getEnvironment(context);
    Log.d(TAG, "OK: getEnvironment result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getEnvironment", e);
}

getLockType

public java.lang.String getLockType()

このメソッドは、現在のロックタイプを取得するために使用されます。出力は以下のいずれかの値になります： パスワード、PIN、スワイプ、なし、またはパターンです。このメソッドは、新しいロック設定で上書きする前に必須のステップです。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getLockType();
    Log.d(TAG, "OK: getLockType result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getLockType", e);
}

setLockType

public int setLockType(java.lang.String pass, java.lang.String type)

このメソッドは、ロックタイプを設定するために使用されます。現在のデバイスロックがパスワードまたはPINの場合、ユーザーはスワイプまたはなしに切り替える前に古い資格情報を入力するよう促されます。新しいロック設定を適用する前に、このメソッドを呼び出す必要があります。

パラメータ

• type – ロックタイプを設定するための文字列値。

戻り値

0 = 成功、-1 = 不明なエラー、-2 = PINが間違っている、-3 = パスワードが間違っている、-4 = システムサービスが接続されていない

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.setLockType("pass", "type");
    Log.d(TAG, "OK: setLockType result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: setLockType", e);
}

getHostName

public java.lang.String getHostName()

このメソッドは、デバイスのホスト名を取得するために使用されます。

戻り値

ホスト名

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getHostName();
    Log.d(TAG, "OK: getHostName result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getHostName", e);
}

setHostName

public void setHostName(java.lang.String hostname)

このメソッドは、デバイスのホスト名を設定するために使用されます。

パラメータ

• hostname – デバイスに割り当てるホスト名。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.setHostName("hostname");
    Log.d(TAG, "OK: setHostName result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: setHostName", e);
}

getMCUVersion

public java.lang.String getMCUVersion()

このメソッドは、利用可能なMCUのバージョンを取得するために使用されます。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getMCUVersion();
    Log.d(TAG, "OK: getMCUVersion result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getMCUVersion", e);
}

getSerialNumber

public java.lang.String getSerialNumber()

このメソッドは、デバイスのシリアル番号を取得するために使用されます。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getSerialNumber();
    Log.d(TAG, "OK: getSerialNumber result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getSerialNumber", e);
}

getModelName

public java.lang.String getModelName()

このメソッドは、デバイスのモデル名を取得するために使用されます。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getModelName();
    Log.d(TAG, "OK: getModelName result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getModelName", e);
}

getProductName

public java.lang.String getProductName()

このメソッドは、デバイスの製品名を取得するために使用されます。

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.getProductName();
    Log.d(TAG, "OK: getProductName result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: getProductName", e);
}

toggleWifi

public void toggleWifi(boolean wifiEnabled)

このメソッドは、Wi-Fiを有効にするか無効にします。

パラメータ

• wifiEnabled – boolean値.

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.toggleWifi(true);
    Log.d(TAG, "OK: toggleWifi result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: toggleWifi", e);
}

toggleBT

public void toggleBT(boolean btEnabled)

このメソッドはBluetoothを有効にまたは無効にします。

パラメータ

• btEnabled – boolean値.

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.toggleBT(true);
    Log.d(TAG, "OK: toggleBT result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: toggleBT", e);
}

toggleUSB

public void toggleUSB(boolean usbEnabled)

このメソッドは、USBを有効にまたは無効にします。

パラメータ

• usbEnabled – boolean値.

例

try {
    // TODO: サービスがバインドされていることを確認してからSDK APIを呼び出します
    Object result = sdk.toggleUSB(true);
    Log.d(TAG, "OK: toggleUSB result=" + result);
} catch (Exception e) {
    Log.e(TAG, "FAIL: toggleUSB", e);
}