Javavoid addSubscribeListener(V2NIMSubscribeListener listener);

Objective-C- (void)addSubscribeListener:(id<V2NIMSubscribeListener>)listener;

C++virtual void addSubscribeListener(const V2NIMSubscribeListener& listener) = 0;

JavaV2NIMSubscribeListener listener = new V2NIMSubscribeListener() {
  @Override
  public void onUserStatusChanged(List<V2NIMUserStatus> userStatusList) {
   //用户状态变更
  }
};
NIMClient.getService(V2NIMSubscriptionService.class).addSubscribeListener(listener);

Objective-C[NIMSDK.sharedSDK.v2SubscriptionService addSubscribeListener:self];

C++V2NIMSubscribeListener listener;
listener.onUserStatusChanged = [](nstd::vector<V2NIMUserStatusEvent> events) {
    // handle user status changed event
};
subscriptionService.addSubscribeListener(listener);

Javavoid removeSubscribeListener(V2NIMSubscribeListener listener);

Objective-C- (void)removeSubscribeListener:(id<V2NIMSubscribeListener>)listener;

C++virtual void removeSubscribeListener(const V2NIMSubscribeListener& listener) = 0;

JavaNIMClient.getService(V2NIMSubscriptionService.class).removeSubscribeListener(listener);

Objective-C[NIMSDK.sharedSDK.v2SubscriptionService removeSubscribeListener:self];

C++subscriptionService.removeSubscribeListener(listener);

TypeScriptinterface V2NIMSubscriptionService extends EventEmitter3<V2NIMSubscribeListener> {
  /**
   * 继承自 eventEmitter3 的监听事件方法
   */
  on<T extends keyof I>(eventName: T, fn: (...args: I[T]) => void): void
  /**
   * 继承自 eventEmitter3 的监听事件方法
   */
  once<T extends keyof I>(eventName: T, fn: (...args: I[T]) => void): void
}

TypeScriptnim.V2NIMSubscriptionService.on("onUserStatusChanged", function (userStatusList: Array<V2NIMUserStatus>) {})

TypeScriptinterface V2NIMSubscriptionService extends EventEmitter3<V2NIMSubscribeListener> {
  /**
   * 继承自 eventEmitter3 的取消监听方法
   */
  off<T extends keyof I>(eventName: T, fn: (...args: I[T]) => void): void
  /**
   * 继承自 eventEmitter3 的移除事件方法
   */
  removeAllListeners<T extends keyof I>(eventName?: T): void
}

TypeScriptnim.V2NIMSubscriptionService.off("onUserStatusChanged", function (userStatusList: Array<V2NIMUserStatus>) {})

Javavoid subscribeUserStatus(V2NIMSubscribeUserStatusOption option, V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);

Objective-C- (void)subscribeUserStatus:(V2NIMSubscribeUserStatusOption *_Nonnull)option
                    success:(nullable V2NIMSubscribeUserStatusCallback)success
                    failure:(nullable V2NIMFailureCallback)failure;

C++virtual void subscribeUserStatus(const V2NIMSubscribeUserStatusOption &option,
    const V2NIMSuccessCallback<const std::vector<std::string> &> &success,
    const V2NIMFailureCallback &failure) = 0;

TypeScriptsubscribeUserStatus(option: V2NIMSubscribeUserStatusOption): Promise<Array<string>>

JavaList<String> accountIds = Arrays.asList("account1", "account2");
//订阅的有效期，时间范围为 60~2592000，单位：秒
long duration = 60L;
//订阅后是否立即同步事件状态值，默认为 false。为 true：表示立即同步当前状态值 但为了性能考虑，30S 内重复订阅，会忽略该参数
boolean immediateSync = false;
V2NIMSubscribeUserStatusOption option = new V2NIMSubscribeUserStatusOption(accountIds, duration, immediateSync);
NIMClient.getService(V2NIMSubscriptionService.class).subscribeUserStatus(option, new V2NIMSuccessCallback<List<String>>() {
  @Override
  public void onSuccess(List<String> failList) {
   //订阅成功,返回订阅失败的 failList
  }
}, new V2NIMFailureCallback() {
  @Override
  public void onFailure(V2NIMError error) {
   //订阅失败
  }
});

Objective-CV2NIMSubscribeUserStatusOption *option = [[V2NIMSubscribeUserStatusOption alloc] init];
    option.accountIds = @[@"accId1",@"accId2"];
    [NIMSDK.sharedSDK.v2SubscriptionService subscribeUserStatus:option success:^(NSArray<NSString *> *failedList) {
           // 成功回调
        } failure:^(V2NIMError * _Nonnull error) {
            // 失败回调
        }];

C++V2NIMSubscribeUserStatusOption option;
option.accountIds.push_back("account1");
subscriptionService.subscribeUserStatus(
    option,
    [](nstd::vector<nstd::string> failedAccounts) {
        // subscribe user status succeeded
    },
    [](V2NIMError error) {
        // subscribe user status failed, handle error
    });

TypeScripttry {
    const failedAccounts = await nim.V2NIMSubscriptionService.subscribeUserStatus({
        accountIds: ['user1', 'user2'],
        duration: 3600 * 24
    })
    if (failedAccounts.length > 0) {
       console.error('subscribeUserStatus failed accounts', failedAccounts)
    }
} catch(err) {
    console.error('subscribeUserStatus err': err)
}

无返回值。

Promise<Array>

• 请求成功，返回 V2NIMSuccessCallback 回调。
• 请求失败，返回 V2NIMFailureCallback 回调，包含用户订阅相关错误码。

• 请求成功，返回 V2NIMSubscribeUserStatusCallback 回调，可自定义设置。
• 请求失败，返回 V2NIMFailureCallback 回调，包含用户订阅相关错误码。

无。

Javavoid unsubscribeUserStatus(V2NIMUnsubscribeUserStatusOption option, V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);

Objective-C- (void)unsubscribeUserStatus:(V2NIMUnsubscribeUserStatusOption *_Nonnull)option
                      success:(nullable V2NIMUnsubscribeUserStatusCallback)success
                      failure:(nullable V2NIMFailureCallback)failure;

C++virtual void unsubscribeUserStatus(const V2NIMUnsubscribeUserStatusOption& option,
    const V2NIMSuccessCallback<nstd::vector<nstd::string>>& success,
    const V2NIMFailureCallback& failure) = 0;

TypeScriptunsubscribeUserStatus(option: V2NIMUnsubscribeUserStatusOption): Promise<Array<string>>

JavaList<String> accountIds = Arrays.asList("account1", "account2");
V2NIMUnsubscribeUserStatusOption option = new V2NIMUnsubscribeUserStatusOption(accountIds);
NIMClient.getService(V2NIMSubscriptionService.class).unsubscribeUserStatus(option, new V2NIMSuccessCallback<List<String>>() {
  @Override
  public void onSuccess(List<String> failList) {
   //取消订阅成功,返回取消订阅失败的 failList
  }
}, new V2NIMFailureCallback() {
  @Override
  public void onFailure(V2NIMError error) {
   //取消订阅失败
  }
});

Objective-CV2NIMUnsubscribeUserStatusOption *option = [[V2NIMUnsubscribeUserStatusOption alloc] init];
    option.accountIds = @[@"accId1",@"accId2"];
    [NIMSDK.sharedSDK.v2SubscriptionService unsubscribeUserStatus:option success:^(NSArray<NSString *> *failedList) {
        // 成功回调
    } failure:^(V2NIMError * _Nonnull error) {
        // 失败回调
    }];

C++V2NIMUnsubscribeUserStatusOption option;
option.accountIds.push_back("account1");
subscriptionService.unsubscribeUserStatus(
    option,
    [](nstd::vector<nstd::string> failedAccounts) {
        // unsubscribe user status succeeded
    },
    [](V2NIMError error) {
        // unsubscribe user status failed, handle error
    });

TypeScripttry {
    const failedAccounts = await nim.V2NIMSubscriptionService.unsubscribeUserStatus({
        accountIds: ['user1', 'user2']
    })
    if (failedAccounts.length > 0) {
       console.error('unsubscribeUserStatus failed accounts', failedAccounts)
    }
} catch(err) {
    console.error('unsubscribeUserStatus err': err)
}

无返回值。

Promise<Array>

• 请求成功，返回 V2NIMSuccessCallback 回调。
• 请求失败，返回 V2NIMFailureCallback 回调，包含用户订阅相关错误码。

• 请求成功，返回 V2NIMUnsubscribeUserStatusCallback 回调，可自定义设置。
• 请求失败，返回 V2NIMFailureCallback 回调，包含用户订阅相关错误码。

无。

Javavoid queryUserStatusSubscriptions(List<String> accountIds, V2NIMSuccessCallback<List<V2NIMUserStatusSubscribeResult>> success, V2NIMFailureCallback failure);

Objective-C- (void)queryUserStatusSubscriptions:(NSArray<NSString *>*_Nullable)accountIds
                             success:(nullable V2NIMSubscribeQueryCallback)success
                             failure:(nullable V2NIMFailureCallback)failure;

C++virtual void queryUserStatusSubscriptions(const nstd::vector<nstd::string>& accountIds,
    const V2NIMSuccessCallback<const nstd::vector<V2NIMUserStatusSubscribeResult>&>& success,
    const V2NIMFailureCallback& failure) = 0;

TypeScriptqueryUserStatusSubscriptions(accountIds: Array<string>): Promise<Array<V2NIMUserStatusSubscribeResult>>

JavaList<String> accountIds = Arrays.asList("account1", "account2");
NIMClient.getService(V2NIMSubscriptionService.class).queryUserStatusSubscriptions(accountIds, new V2NIMSuccessCallback<List<V2NIMUserStatusSubscribeResult>>() {
  @Override
  public void onSuccess(List<V2NIMUserStatusSubscribeResult> v2NIMUserStatusSubscribeResults) {
   //查询成功
  }
}, new V2NIMFailureCallback() {
  @Override
  public void onFailure(V2NIMError error) {
   //查询失败
  }
});

Objective-C[NIMSDK.sharedSDK.v2SubscriptionService queryUserStatusSubscriptions:@[@"accId1",@"accId2"] success:^(NSArray<V2NIMUserStatusSubscribeResult *> *resultList) {
        // 成功回调
    } failure:^(V2NIMError * _Nonnull error) {
        // 失败回调
    }];

C++nstd::vector<nstd::string> accountIds;
accountIds.push_back("account1");
subscriptionService.queryUserStatusSubscriptions(
    accountIds,
    [](nstd::vector<nstd::string> subscribedAccounts) {
        // query user status subscribe succeeded
    },
    [](V2NIMError error) {
        // query user status subscribe failed, handle error
    });

TypeScripttry {
    const result = await nim.V2NIMSubscriptionService.queryUserStatusSubscriptions(['user1', 'user2'])
   console.log('queryUserStatusSubscriptions result', result)
 } catch(err) {
    console.error('queryUserStatusSubscriptions err': err)
 }

无返回值。

Promise<Array>

• 请求成功，返回 V2NIMSuccessCallback 回调。
• 请求失败，返回 V2NIMFailureCallback 回调，包含用户订阅相关错误码。

• 请求成功，返回 V2NIMSubscribeQueryCallback 回调，可自定义设置。
• 请求失败，返回 V2NIMFailureCallback 回调，包含用户订阅相关错误码。

无。

Javavoid publishCustomUserStatus(V2NIMCustomUserStatusParams params, V2NIMSuccessCallback<V2NIMCustomUserStatusPublishResult> success, V2NIMFailureCallback failure);

Objective-C- (void)publishCustomUserStatus:(V2NIMCustomUserStatusParams *_Nonnull)params
                        success:(nullable V2NIMCustomUserStatusPublishCallback)success
                        failure:(nullable V2NIMFailureCallback)failure;

C++virtual void publishCustomUserStatus(const V2NIMCustomUserStatusParams& params,
    const V2NIMSuccessCallback<const V2NIMCustomUserStatusPublishResult&>& success,
    const V2NIMFailureCallback& failure) = 0;

TypeScriptpublishCustomUserStatus(params: V2NIMCustomUserStatusParams): Promise<V2NIMCustomUserStatusPublishResult>

Java//自定义设置值：10000 以上，包括一万，一万以内为预定义值
int statusType = 10001;
//状态的有效期，单位秒，范围为 60s 到 7days
long duration = 60L;
//用户发布状态时设置的扩展字段
String extension = "{\"key\":\"value\"}";
//用户发布状态时是否只广播给在线的订阅者，默认值为 TRUE
boolean onlineOnly = true;
// 用户发布状态时是否需要多端同步，默认值为 FALSE
boolean multiSync = false;
//自定义用户状态参数
V2NIMCustomUserStatusParams params = new V2NIMCustomUserStatusParams.Builder(statusType,duration)
   .extension(extension)
   .onlineOnly(onlineOnly)
   .multiSync(multiSync)
   .build();
NIMClient.getService(V2NIMSubscriptionService.class).publishCustomUserStatus(params, new V2NIMSuccessCallback<V2NIMCustomUserStatusPublishResult>() {
  @Override
  public void onSuccess(V2NIMCustomUserStatusPublishResult v2NIMCustomUserStatusPublishResult) {
   //发布自定义用户状态成功
  }
}, new V2NIMFailureCallback() {
  @Override
  public void onFailure(V2NIMError error) {
   //发布自定义用户状态失败
  }
});

Objective-C V2NIMCustomUserStatusParams *params = [[V2NIMCustomUserStatusParams alloc] init];
    params.statusType = 10001;
    [NIMSDK.sharedSDK.v2SubscriptionService publishCustomUserStatus:params success:^(V2NIMCustomUserStatusPublishResult *resultList) {
        // 成功回调
    } failure:^(V2NIMError * _Nonnull error) {
        // 失败回调
    }];

C++V2NIMCustomUserStatusParams params;
params.statusType = 100001;
subscriptionService.publishCustomUserStatus(
    params,
    []() {
        // publish custom user status succeeded
    },
    [](V2NIMError error) {
        // publish custom user status failed, handle error
    });

TypeScripttry {
    const result = await nim.V2NIMSubscriptionService.publishCustomUserStatus({
          /**
           * 自定义设置值：10000 以上，不包括一万，一万以内为预定义值。小于 1 万，返回参数错误
           */
          statusType: 10001
          /**
           * 状态的有效期，单位秒，范围为 60s 到 7days
           */
          duration: 3600 * 24
          /**
           * 用户发布状态时是否只广播给在线的订阅者。默认为 true
           */
          onlineOnly: false
          /**
           * 用户发布状态时是否需要多端同步。默认为 false
           */
          multiSync: true
    })
   console.log('publishCustomUserStatus result', result)
 } catch(err) {
    console.error('publishCustomUserStatus err': err)
 }

无返回值。

Promise<V2NIMCustomUserStatusPublishResult>

• 请求成功，返回 V2NIMSuccessCallback 回调。
• 请求失败，返回 V2NIMFailureCallback 回调，包含用户订阅相关错误码。

• 请求成功，返回 V2NIMCustomUserStatusPublishCallback 回调，可自定义设置。
• 请求失败，返回 V2NIMFailureCallback 回调，包含用户订阅相关错误码。

无。