V2NIMSubscriptionService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.subscription;

import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.subscription.option.V2NIMSubscribeUserStatusOption;
import com.netease.nimlib.sdk.v2.subscription.option.V2NIMUnsubscribeUserStatusOption;
import com.netease.nimlib.sdk.v2.subscription.params.V2NIMCustomUserStatusParams;
import com.netease.nimlib.sdk.v2.subscription.result.V2NIMCustomUserStatusPublishResult;
import com.netease.nimlib.sdk.v2.subscription.result.V2NIMUserStatusSubscribeResult;
import java.util.List;

public interface V2NIMSubscriptionService {

    /**
     * 订阅用户状态，包括在线状态，或自定义状态
     * 单次订阅人数最多100，如果有较多人数需要调用，需多次调用该接口
     * 如果同一账号多端重复订阅， 订阅有效期会默认后一次覆盖前一次时长
     * 总订阅人数最多3000， 被订阅人数3000，为了性能考虑，
     * 在线状态事件订阅是单向的，双方需要各自订阅。
     * 如果接口整体失败，则返回调用错误码
     * 如果部分账号失败，则返回失败账号列表
     * 订阅接口后，有成员在线状态变更会触发回调：onUserStatusChanged
     * @param option 订阅请求参数
     * @param success 成功回调, 返回订阅失败的账号列表
     * @param failure 失败回调
     */
    void subscribeUserStatus(V2NIMSubscribeUserStatusOption option, V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);

    /**
     * 取消用户状态订阅请求
     * @param option 取消订阅请求参数
     * @param success 成功回调, 返回取消订阅失败的账号列表
     * @param failure 失败回调
     */
    void unsubscribeUserStatus(V2NIMUnsubscribeUserStatusOption option, V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);
    /**
     * 发布用户自定义状态，如果默认在线状态不满足业务需求，可以发布自定义用户状态
     * @param params 自定义用户状态参数
     * @param success 成功回调
     * @param failure 失败回调
     */
    void publishCustomUserStatus(V2NIMCustomUserStatusParams params, V2NIMSuccessCallback<V2NIMCustomUserStatusPublishResult> success, V2NIMFailureCallback failure);

    /**
     * 查询用户状态订阅关系
     * 输入账号列表，查询自己订阅了哪些账号列表， 返回订阅账号列表
     * @param accountIds 需要查询的账号列表，查询自己是否订阅了对应账号
     * 如果账号列表为空， 表示查询用户状态的所有订阅关系，就是自定全部订阅了哪些账号
     * 如果账号列表不为空，单次查询不超过3000， 数值越大查询时间越久，尽量按需查询，建议限制在100以内
     * @param success 成功回调
     * @param failure 失败回调
     */
    void queryUserStatusSubscriptions(List<String> accountIds, V2NIMSuccessCallback<List<V2NIMUserStatusSubscribeResult>> success, V2NIMFailureCallback failure);

    /**
     * 添加用户状态订阅的监听器
     * @param listener 订阅监听
     */
    void addSubscribeListener(V2NIMSubscribeListener listener);

    /**
     * 移除用户状态订阅的监听器
     * @param listener 订阅监听
     */
    void removeSubscribeListener(V2NIMSubscribeListener listener);
}