api.getChatJoinRequests()
Returns pending join requests in a chat
Parameters
GetChatJoinRequestsParams
:chevron_leftchevron_right
Parameters
Interface
Name | Type | Description |
---|---|---|
chatId | number | Chat identifier |
inviteLink | string | Invite link for which to return join requests. If empty, all join requests will be returned. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links |
query | string | A query to search for in the first names, last names and usernames of the users to return |
offsetRequest | A chat join request from which to return next requests; pass null to get results from the beginning | |
limit | number | The maximum number of requests to join the chat to return |
Returns
ApiResponse
interface:interface ApiResponse {
_: 'getChatJoinRequests' | 'error'
airgram: Airgram
request: {
method: 'getChatJoinRequests'
params: GetChatJoinRequestsParams
}
response: |
setState: (nextState: Record<string, unknown>) => void
getState: () => Record<string, unknown>
}