new ConversationQuery(client)
- Source:
Create a ConversationQuery
Parameters:
Name | Type | Description |
---|---|---|
client |
IMClient |
Methods
addAscending(key) → {ConversationQuery}
- Source:
设置返回集合按照指定key进行增序排列,如果已设置其他排序,原排序的优先级较高
Parameters:
Name | Type | Description |
---|---|---|
key |
string |
Returns:
self
- Type
- ConversationQuery
addDescending(key) → {ConversationQuery}
- Source:
设置返回集合按照指定 key 进行降序排列,如果已设置其他排序,原排序的优先级较高
Parameters:
Name | Type | Description |
---|---|---|
key |
string |
Returns:
self
- Type
- ConversationQuery
ascending(key) → {ConversationQuery}
- Source:
设置返回集合按照指定key进行增序排列
Parameters:
Name | Type | Description |
---|---|---|
key |
string |
Returns:
self
- Type
- ConversationQuery
compact(enabledopt) → {ConversationQuery}
- Source:
设置返回的 conversations 为精简模式,即不含成员列表
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
enabled |
Boolean |
<optional> |
true
|
Returns:
self
- Type
- ConversationQuery
containedIn(key, values) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段对应的值包含在指定值中时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
values |
Returns:
self
- Type
- ConversationQuery
contains(key, subString) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段对应的值包含此字符串即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
subString |
string |
Returns:
self
- Type
- ConversationQuery
containsAll(key, values) → {ConversationQuery}
- Source:
增加查询条件,当conversation的属性中对应的字段中的元素包含所有的值才可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
values |
Returns:
self
- Type
- ConversationQuery
containsMembers(peerIds) → {ConversationQuery}
- Source:
增加查询条件,指定聊天室的组员包含某些成员即可返回
Parameters:
Name | Type | Description |
---|---|---|
peerIds |
Array.<string> | 成员 ID 列表 |
Returns:
self
- Type
- ConversationQuery
descending(key) → {ConversationQuery}
- Source:
设置返回集合按照指定 key 进行降序排列
Parameters:
Name | Type | Description |
---|---|---|
key |
string |
Returns:
self
- Type
- ConversationQuery
doesNotExist(key) → {ConversationQuery}
- Source:
- Since:
- 3.5.0
增加查询条件,当 conversation 不存在指定的字段时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string |
Returns:
self
- Type
- ConversationQuery
endsWith(key, suffix) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段对应的值以此字符串结束即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
suffix |
string |
Returns:
self
- Type
- ConversationQuery
equalTo(key, value) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段满足等于条件时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
value |
Returns:
self
- Type
- ConversationQuery
exists(key) → {ConversationQuery}
- Source:
- Since:
- 3.5.0
增加查询条件,当 conversation 存在指定的字段时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string |
Returns:
self
- Type
- ConversationQuery
find() → {Promise.<Array.<Conversation>>}
- Source:
执行查询
Returns:
- Type
- Promise.<Array.<Conversation>>
greaterThan(key, value) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段满足大于条件时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
value |
Returns:
self
- Type
- ConversationQuery
greaterThanOrEqualTo(key, value) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段满足大于等于条件时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
value |
Returns:
self
- Type
- ConversationQuery
lessThan(key, value) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段满足小于条件时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
value |
Returns:
self
- Type
- ConversationQuery
lessThanOrEqualTo(key, value) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段满足小于等于条件时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
value |
Returns:
self
- Type
- ConversationQuery
limit(limit) → {ConversationQuery}
- Source:
设置返回集合的大小上限
Parameters:
Name | Type | Description |
---|---|---|
limit |
Number | 上限 |
Returns:
self
- Type
- ConversationQuery
matches(key, regex) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段对应的值满足提供的正则表达式即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
regex |
RegExp |
Returns:
self
- Type
- ConversationQuery
notContainsIn(key, values) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段对应的值不包含在指定值中时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
values |
Returns:
self
- Type
- ConversationQuery
notEqualTo(key, value) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段满足不等于条件时即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
value |
Returns:
self
- Type
- ConversationQuery
sizeEqualTo(key, length) → {ConversationQuery}
- Source:
添加查询约束条件,查找 key 类型是数组,该数组的长度匹配提供的数值
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
length |
Number |
Returns:
self
- Type
- ConversationQuery
skip(skip) → {ConversationQuery}
- Source:
设置返回集合的起始位置,一般用于分页
Parameters:
Name | Type | Description |
---|---|---|
skip |
Number | 起始位置跳过几个对象 |
Returns:
self
- Type
- ConversationQuery
startsWith(key, prefix) → {ConversationQuery}
- Source:
增加查询条件,当 conversation 的属性中对应的字段对应的值以此字符串起始即可返回
Parameters:
Name | Type | Description |
---|---|---|
key |
string | |
prefix |
string |
Returns:
self
- Type
- ConversationQuery
withLastMessages(enabledopt) → {ConversationQuery}
- Source:
- Deprecated:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
enabled |
Boolean |
<optional> |
true
|
Returns:
self
- Type
- ConversationQuery
withLastMessagesRefreshed(enabledopt) → {ConversationQuery}
- Source:
设置返回的 conversations 刷新最后一条消息
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
enabled |
Boolean |
<optional> |
true
|
Returns:
self
- Type
- ConversationQuery
withMembers(peerIds, includeSelf) → {ConversationQuery}
- Source:
增加查询条件,指定聊天室的组员条件满足条件的才返回
Parameters:
Name | Type | Description |
---|---|---|
peerIds |
Array.<string> | 成员 ID 列表 |
includeSelf |
Boolean | 是否包含自己 |
Returns:
self
- Type
- ConversationQuery