文档首页

API 说明

API 说明¶

RongPushCient API 说明

/**
 * 设置 push 相关配置。
 *
 * @param config push 配置。{@link PushConfig.Builder}
 */
public static void setPushConfig(PushConfig config) {
    pushConfig = config;
}

/**
* 处理华为push连接错误，由终端用户操作解决.
* 当错误码为以下错误码才能通过终端用户操作解决:
* {@link com.huawei.hms.api.ConnectionResult#SERVICE_MISSING}
* {@link com.huawei.hms.api.ConnectionResult#SERVICE_VERSION_UPDATE_REQUIRED}
* {@link com.huawei.hms.api.ConnectionResult#BINDFAIL_RESOLUTION_REQUIRED}
*
* @param activity  当前界面的activity， 不能传空
* @param errorCode 错误码
*/
public static void resolveHWPushError(Activity activity, long errorCode) throws RongException {}

/**
* 清除通知栏所有通知消息。
*
* @param context 上下文
*/
public static void clearAllNotifications(Context context) {}

/**
* <p>清除所有的推送通知和后台消息通知。ex: A 账号离线或者退到后台，B 账号给 A 发送消息，A 设备会收到该消息的通知，调用此函数会清除该类型的通知。
* 但是，如果是从开发者后台使用广播推送服务发送的推送通知，仍然会保留，不会清除   </p>。
*
* @param context 上下文。
*/
public static void clearAllPushNotifications(Context context) {}

/**
* 清除所有后台推送服务的推送通知。后台推送服务，是指开发者后台的广播推送服务。
*
* @param context 上下文。
*/
public static void clearAllPushServiceNotifications(Context context) {}

/**
* 根据 notification id 清除通知栏。
*
* @param context        上下文。
* @param notificationId 通知栏消息 id。
*/
public static void clearNotificationById(Context context, int notificationId) {}

/**
* <p>记录在开发者后台使用后台推送功能时，对应的推送通知的点击事件。开发者后台的推送打开率既根据客户端上传的该事件进行相应统计和计算。
* 2.6.0之前版本，推送打开率的使用请在知识库里搜索标签 push，有相关说明。
* 2.6.0之后版本，如果用户使用的 SDK 内置的通知实现，则不需要调用该方法来统计推送打开率，SDK 内部已经帮用户做了统计。
* 但是如果用户自己定义了推送时通知栏的显示，则需要在点击通知时，调用此方法，来向服务器上传推送打开事件。</p>
*
* @param pushId push 通知的 Id。只有使用开发者后台广播消息和开发者后台推送服务时，pushId 才会有值，其余非后台情况下都为空。
*/
public static void recordNotificationEvent(String pushId){}

/**
* 停止融云 push 服务,如果用的第三方推送,也会断掉和第三方推送的连接。
*
* @param context 应用上下文
*/
public static void stopService(Context context){}

/**
* 发送通知。如果使用 IMLib 开发，当应用在后台需要弹后台通知时，可以直接调用此函数弹出通知。
*
* @param context             上下文
* @param notificationMessage 融云对外公开的通知消息。
*/
public static void sendNotification(Context context, PushNotificationMessage notificationMessage) {}

PushNotificationMessage 成员列表

API	功能	备注
`getPushId()`	获取标识该推送消息的唯一 Id。当使用开发者后台的广播推送服务时，该 Id 用来追踪推送打开率。只有当使用开发者后台的广播推送服务时，返回有效字符串。其余情况，返回 null。	如果您自定义了推送通知的展示，在点击通知时需要调用 RongPushClient.recordNotificationEvent() 来上传推送打开事件，以便融云后台正确的帮您统计推送打开率。如果您没有自定义通知，则不需要额外操作，SDK 内部已经帮您做了打开率的统计。
`getConversationType()`	获取该推送消息所属的会话类型。比如单聊，群组，讨论组等。
`getTargetId()`	获取该推送消息的目标 Id。	比如单聊时，是对方的 Id ; 群组时，是群 Id ; 讨论组时，是该讨论组 Id。
`getTargetUserName()`	获取该推送消息的目标名称。	单聊时，返回对方的名称; 群组时，返回群名称; 讨论组时，返回该讨论组的名称。
`getReceivedTime()`	获取该推送消息的到达时间。该时间是此条消息到达融云服务器的时间。
`getObjectName()`	获取该推送消息的消息类型。	比如文本消息为 “RC:TxtMsg”，图片消息为“RC:ImgMsg”，语音消息为 “RC:VcMsg”，或者如果是自定义消息，则此处对应自定义消息的注解 MessageTag 里 value 的值。
`getSenderId()`	获取该推送消息的发送者 Id。
`getSenderName()`	获取该推送消息的发送者名称。
`getSenderPortrait()`	获取该推送消息的发送者头像。
`getPushTitle()`	推送标题，目前此字段暂未启用。
`getPushContent()`	获取推送通知的显示内容。	当该推送消息是自定义消息时，此处的值对应 sendMessage() 的参数 pushContent 的内容。如果您在发送自定义消息时，没有填写 pushContent，则收不到推送。
`getPushData()`	获取推送消息携带的附加信息。此处的值对应 sendMessage() 的参数 pushData 的内容。	发送自定义消息时，如果在 sendMessage() 时填写参数 pushData, 则收到这条消息的推送时，可以通过该方法获取 pushData 的内容。
`getExtra()`	获取从开发者后台使用推送服务时，自定义的附加信息键值对。	该字段仅为开发者后台的推送服务使用，其余情况为 null。
`getPushFlag()`	标识该消息是推送消息还是后台消息。