API 说明 - 客户端

消息推送包含以下客户端 API 接口，具体描述见下表：

RPC 调用

mPaaS 中间层的 MPPush 类封装了移动推送组件所有 API，包括绑定、解绑以及三方渠道设备上报等接口。

绑定 - RPC

• 方法定义
  

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

  本方法用于绑定用户标识和设备标识。绑定完成后，可基于用户维度推送消息。

  说明：本接口需要在子线程中进行调用。

• 参数说明

  ctx	Context：一个不为空的 Context。
  userId	String：用户唯一标识，该标识不一定为接入方用户系统中的真实标识，但一定可以与用户形成一一映射关系。
  token	String：由移动推送网关下发的设备标识。

• 返回值

  sucess	接口调用是否成功，ture：成功；false：失败。
  code	操作结果码，常见的操作结果码及其含义参见下表。
  name	操作结果码的名称。
  message	操作结果码对应的描述信息。

  操作结果码说明

  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("绑定用户操作", resultPbPB);
    }

解绑 - RPC

• 方法定义
  

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

  本方法用于解绑用户标识和设备标识。

  说明：本接口需要在子线程中进行调用。

• 参数说明

  ctx	Context：一个不为空的 Context。
  userId	String：用户唯一标识，该标识不一定为接入方用户系统中的真实标识，但一定可以与用户形成一一映射关系。
  token	String：由移动推送网关下发的设备标识。

• 返回值
  调用本方法的返回值参见 返回值。

• 使用示例

    private void doSimpleUnBind() {
        final ResultPbPB resultPbPB = MPPush.unbind(getApplicationContext()
                , mUserId, PushMsgService.mAdToken);
        handlePbPBResult("解绑定用户操作", resultPbPB);
    }

三方渠道设备上报 - RPC

• 方法定义
  

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

  该方法用于同步绑定三方渠道设备标识与本机设备标识。

  说明：本方法用于上报三方渠道设备标识和 mPaaS 设备标识（移动推送网关下发的 Ad-token）至移动推送核心，移动推送核心将绑定这两个标识。完成此过程后，方可使用三方渠道推送消息。

• 参数说明

  ctx	Context：一个不为空的 Context。
  deliveryToken	String：由移动推送网关下发的设备标识（Ad-token）。
  thirdChannel	int：三方渠道厂商。4：小米；5：华为。
  thirdChannelDeviceToken	String：三方渠道设备标识

• 返回值
  调用本方法的返回值参见 返回值。

• 使用示例

    private void doSimpleUploadToken() {
        final ResultPbPB resultPbPB = MPPush.report(getApplicationContext(), PushMsgService.mAdToken
                , PushOsType.HUAWEI.value(), PushMsgService.mThirdToken);
        handlePbPBResult("第三方push标识上报操作", resultPbPB);