NIMSDK-AOS  10.9.50
| Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams类 参考

搜索群成员参数类 更多...

class  Builder
 V2NIMSearchTeamMemberParams的Builder类
 

Public 成员函数

 V2NIMSearchTeamMemberParams ()
 默认构造方法 更多...
 
List< String > getKeywordList ()
 获取关键字列表 更多...
 
void setKeywordList (List< String > keywordList)
 设置关键字列表 更多...
 
V2NIMSearchKeywordMathType getKeywordMatchType ()
 获取关键字匹配类型 更多...
 
void setKeywordMatchType (V2NIMSearchKeywordMathType keywordMatchType)
 设置关键字匹配类型 更多...
 
List< V2NIMTeamRefergetTeamRefers ()
 获取群组引用列表 更多...
 
void setTeamRefers (List< V2NIMTeamRefer > teamRefers)
 设置群组引用列表 更多...
 
boolean isSearchAccountId ()
 是否搜索用户账号 更多...
 
void setSearchAccountId (boolean searchAccountId)
 设置是否搜索用户账号 更多...
 
boolean isSearchTeamNick ()
 是否搜索群昵称 更多...
 
void setSearchTeamNick (boolean searchTeamNick)
 设置是否搜索群昵称 更多...
 
int getLimit ()
 获取单次检索返回的数量限制 更多...
 
void setLimit (int limit)
 设置单次检索返回的数量限制 仅服务器有效 更多...
 
String getNextToken ()
 获取起始位置标记 更多...
 
void setNextToken (String nextToken)
 设置起始位置标记 仅服务器有效 更多...
 
boolean isValid ()
 验证参数有效性 更多...
 
String isValidWithErrorMsg ()
 验证参数有效性 更多...
 
String toString ()
 

详细描述

搜索群成员参数类

该类用于配置搜索群成员的各种参数,包括关键字列表、匹配类型、目标群组等。 支持在指定群组中搜索成员,也支持全局搜索所有群成员。

在文件 V2NIMSearchTeamMemberParams.java16 行定义.

构造及析构函数说明

com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.V2NIMSearchTeamMemberParams ( )

默认构造方法

初始化默认值:

  • keywordMatchType: V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR
  • searchAccountId: false
  • searchTeamNick: true
  • limit: 20
  • nextToken: ""

在文件 V2NIMSearchTeamMemberParams.java103 行定义.

成员函数说明

List<String> com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.getKeywordList ( )

获取关键字列表

返回
关键字列表,可能为null

在文件 V2NIMSearchTeamMemberParams.java116 行定义.

V2NIMSearchKeywordMathType com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.getKeywordMatchType ( )

获取关键字匹配类型

返回
关键字匹配类型

在文件 V2NIMSearchTeamMemberParams.java134 行定义.

int com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.getLimit ( )

获取单次检索返回的数量限制

返回
数量限制

在文件 V2NIMSearchTeamMemberParams.java206 行定义.

String com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.getNextToken ( )

获取起始位置标记

返回
起始位置标记

在文件 V2NIMSearchTeamMemberParams.java225 行定义.

List<V2NIMTeamRefer> com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.getTeamRefers ( )

获取群组引用列表

返回
群组引用列表,可能为null

在文件 V2NIMSearchTeamMemberParams.java152 行定义.

boolean com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.isSearchAccountId ( )

是否搜索用户账号

返回
true表示搜索用户账号,false表示不搜索

在文件 V2NIMSearchTeamMemberParams.java170 行定义.

boolean com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.isSearchTeamNick ( )

是否搜索群昵称

返回
true表示搜索群昵称,false表示不搜索

在文件 V2NIMSearchTeamMemberParams.java188 行定义.

boolean com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.isValid ( )

验证参数有效性

返回
true表示参数有效,false表示参数无效

在文件 V2NIMSearchTeamMemberParams.java245 行定义.

String com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.isValidWithErrorMsg ( )

验证参数有效性

返回
true表示参数有效,false表示参数无效

在文件 V2NIMSearchTeamMemberParams.java274 行定义.

void com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.setKeywordList ( List< String >  keywordList)

设置关键字列表

参数
keywordList关键字列表,最多5个,不能为null或空

在文件 V2NIMSearchTeamMemberParams.java125 行定义.

void com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.setKeywordMatchType ( V2NIMSearchKeywordMathType  keywordMatchType)

设置关键字匹配类型

参数
keywordMatchType关键字匹配类型

在文件 V2NIMSearchTeamMemberParams.java143 行定义.

void com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.setLimit ( int  limit)

设置单次检索返回的数量限制 仅服务器有效

参数
limit数量限制,必须为正数

在文件 V2NIMSearchTeamMemberParams.java216 行定义.

void com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.setNextToken ( String  nextToken)

设置起始位置标记 仅服务器有效

参数
nextToken起始位置标记

在文件 V2NIMSearchTeamMemberParams.java235 行定义.

void com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.setSearchAccountId ( boolean  searchAccountId)

设置是否搜索用户账号

参数
searchAccountIdtrue表示搜索用户账号,false表示不搜索

在文件 V2NIMSearchTeamMemberParams.java179 行定义.

void com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.setSearchTeamNick ( boolean  searchTeamNick)

设置是否搜索群昵称

参数
searchTeamNicktrue表示搜索群昵称,false表示不搜索

在文件 V2NIMSearchTeamMemberParams.java197 行定义.

void com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.setTeamRefers ( List< V2NIMTeamRefer teamRefers)

设置群组引用列表

参数
teamRefers群组引用列表,最多50个

在文件 V2NIMSearchTeamMemberParams.java161 行定义.

String com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams.toString ( )

在文件 V2NIMSearchTeamMemberParams.java431 行定义.


该类的文档由以下文件生成: