api.searchChatMembers()
Searches for a specified query in the first name, last name and username of the members of a specified chat. Requires administrator rights in channels
Parameters
SearchChatMembersParams
:chevron_leftchevron_right
Parameters
Interface
Name | Type | Description |
---|---|---|
chatId | number | Chat identifier |
query | string | Query to search for |
limit | number | The maximum number of users to be returned; up to 200 |
filter | The type of users to search for; pass null to search among all chat members |
Returns
ApiResponse
interface:interface ApiResponse {
_: 'searchChatMembers' | 'error'
airgram: Airgram
request: {
method: 'searchChatMembers'
params: SearchChatMembersParams
}
response: |
setState: (nextState: Record<string, unknown>) => void
getState: () => Record<string, unknown>
}