Mobile Platform as a Service:クライアント API

mPaaS 中間レイヤーの MPPush クラスは、バインド、アンバインド、サードパーティチャネルデバイスのレポートなど、すべての MPS コンポーネント API をカプセル化します。モバイルゲートウェイのソフトウェア開発キット (SDK) は、これらの API メソッドのリモートプロシージャコール (RPC) を実装します。

バインド

• メソッド定義

  このメソッドは、ユーザー ID をデバイス ID にバインドします。バインドが完了すると、特定のユーザーにメッセージをプッシュできます。このメソッドはサブスレッドで呼び出してください。

    public static ResultPbPB bind(Context ctx, String userId, String token)

• パラメーター

  パラメーター	タイプ	説明
  ctx	Context	空ではない Context。
  userId	String	一意のユーザー識別子。この識別子は、ご利用のユーザーシステムの実際の ID である必要はありませんが、ユーザーと 1 対 1 でマッピングされている必要があります。
  token	String	MPS ゲートウェイによって発行されたデバイス ID。

• 戻り値

  パラメーター	説明
  success	API 呼び出しが成功したかどうかを示します。 true：呼び出しは成功です。 false：呼び出しは失敗です。
  code	操作の結果コード。一般的な結果コードとその説明については、次の表をご参照ください。
  name	操作結果コードの名前。
  message	操作結果コードの説明。

  結果コードの説明

  結果コード	結果コード名	メッセージ	説明
  3012	NEED_USERID	need userid	入力パラメーター userId が空です。
  3001	NEED_DELIVERYTOKEN	need token	入力パラメーター token が空です。

• 例

    private void doSimpleBind() {
        final ResultPbPB resultPbPB = MPPush.bind(getApplicationContext(), mUserId, PushMsgService.mAdToken);
        handlePbPBResult("Bind user operation", resultPbPB);
    }

アンバインド

• メソッド定義

  このメソッドは、ユーザー ID をデバイス ID からアンバインドします。このメソッドはサブスレッドで呼び出してください。

  public static ResultPbPB unbind(Context ctx, String userId, String token)

• パラメーター

  パラメーター	タイプ	説明
  ctx	Context	空ではない Context。
  userId	String	一意のユーザー識別子。この識別子は、ご利用のユーザーシステムの実際の ID である必要はありませんが、ユーザーと 1 対 1 でマッピングされている必要があります。
  token	String	MPS ゲートウェイによって発行されたデバイス ID。

• 戻り値

  このメソッドは、バインドメソッドと同じ値を返します。

• 例

    private void doSimpleUnBind() {
        final ResultPbPB resultPbPB = MPPush.unbind(getApplicationContext()
                , mUserId, PushMsgService.mAdToken);
        handlePbPBResult("Unbind user operation", resultPbPB);
    }

サードパーティチャネルデバイスのレポート

• メソッド定義

  このメソッドは、サードパーティチャネルのデバイス ID と mPaaS デバイス ID (MPS ゲートウェイによって発行された Ad-token) を MPS コアにレポートします。その後、MPS コアはこれら 2 つの識別子を同期的にバインドします。バインドが完了すると、サードパーティチャネル経由でメッセージをプッシュできます。

  フレームワークは内部でこのメソッドを呼び出します。SDK 呼び出しの失敗を防ぐため、このメソッドを手動で再度呼び出す必要があります。

    public static ResultPbPB report(Context context, String deliveryToken, int thirdChannel, String thirdChannelDeviceToken)

• パラメーター

  パラメーター	タイプ	説明
  ctx	Context	空ではない Context。
  deliveryToken	String	MPS ゲートウェイによって発行されたデバイス ID (Ad-token)。
  thirdChannel	int	サードパーティチャネル。列挙値は次のとおりです： 2：Apple 4：Xiaomi 5：Huawei 6：FCM 7：OPPO 8：vivo
  thirdChannelDeviceToken	String	ベンダーチャネルのデバイス ID

• 戻り値

  このメソッドは、バインドメソッドと同じ値を返します。

• 例

    private void doSimpleUploadToken() {
        final ResultPbPB resultPbPB = MPPush.report(getApplicationContext(), PushMsgService.mAdToken
                , PushOsType.HUAWEI.value(), PushMsgService.mThirdToken);
        handlePbPBResult("Third-party push identifier reporting operation", resultPbPB);

トラブルシューティング

RPC リソースの呼び出し中に例外が発生した場合は、「Security Guard の結果コードの説明」をご参照のうえ、問題をトラブルシューティングしてください。