Class ChatJoinRequestUpdateContext

Context of a chat join request update (for bots).

This is a subclass of BotChatJoinRequestUpdate, so all its fields are also available.

Hierarchy (View Summary)

BotChatJoinRequestUpdate
- ChatJoinRequestUpdateContext

Index

Constructors

Properties

_name _peers client raw

Accessors

chat chatId date invite queryId user userBio userId

Methods

answerQuery approve decline

Constructors

constructor

new ChatJoinRequestUpdateContext(
client: TelegramClient,
update: BotChatJoinRequestUpdate,
): ChatJoinRequestUpdateContext
Parameters
- client: TelegramClient
- update: BotChatJoinRequestUpdate
Returns ChatJoinRequestUpdateContext
Overrides BotChatJoinRequestUpdate.constructor
- Defined in packages/dispatcher/src/context/chat-join-request.ts:17

Properties

`Readonly`_name

_name: "bot_chat_join_request" = ...

`Readonly`_peers

_peers: PeersIndex

`Readonly`client

client: TelegramClient

`Readonly`raw

raw: RawUpdateBotChatInviteRequester

Accessors

chat

get chat(): Chat
Object containing the chat information.

Returns Chat
Implementation of UpdateContext.chat
Inherited from BotChatJoinRequestUpdate.chat
- Defined in packages/core/src/highlevel/types/updates/bot-chat-join-request.ts:32

chatId

get chatId(): number
Chat ID where the user is requesting to join.

Returns number
Implementation of UpdateContext.chatId
Inherited from BotChatJoinRequestUpdate.chatId
- Defined in packages/core/src/highlevel/types/updates/bot-chat-join-request.ts:25

date

get date(): Date
Date when the request was sent.

Returns Date
Implementation of UpdateContext.date
Inherited from BotChatJoinRequestUpdate.date
- Defined in packages/core/src/highlevel/types/updates/bot-chat-join-request.ts:60

invite

get invite(): ChatInviteLink
Invite link used to request joining.

Returns ChatInviteLink
Implementation of UpdateContext.invite
Inherited from BotChatJoinRequestUpdate.invite
- Defined in packages/core/src/highlevel/types/updates/bot-chat-join-request.ts:67

queryId

get queryId(): Long | null
If the bot is a guard bot of the chat, ID of the join query, which should be answered with TelegramClient.answerChatJoinRequestQuery

Returns Long | null
Implementation of UpdateContext.queryId
Inherited from BotChatJoinRequestUpdate.queryId
- Defined in packages/core/src/highlevel/types/updates/bot-chat-join-request.ts:75

user

get user(): User
Object containing the user information.

Returns User
Implementation of UpdateContext.user
Inherited from BotChatJoinRequestUpdate.user
- Defined in packages/core/src/highlevel/types/updates/bot-chat-join-request.ts:46

userBio

get userBio(): string
Bio of the user who requested to join the chat.

Returns string
Implementation of UpdateContext.userBio
Inherited from BotChatJoinRequestUpdate.userBio
- Defined in packages/core/src/highlevel/types/updates/bot-chat-join-request.ts:53

userId

get userId(): number
ID of the user who requested to join the chat.

Returns number
Implementation of UpdateContext.userId
Inherited from BotChatJoinRequestUpdate.userId
- Defined in packages/core/src/highlevel/types/updates/bot-chat-join-request.ts:39

Methods

answerQuery

answerQuery(answer: ChatJoinRequestQueryAnswer): Promise<void>
Answer the join query (only if the bot is a guard bot of the chat, see queryId)
Parameters
- answer: ChatJoinRequestQueryAnswer
Returns Promise<void>
- Defined in packages/dispatcher/src/context/chat-join-request.ts:43

approve

approve(): Promise<void>
Approve the request

Returns Promise<void>
- Defined in packages/dispatcher/src/context/chat-join-request.ts:25

decline

decline(): Promise<void>
Decline the request

Returns Promise<void>
- Defined in packages/dispatcher/src/context/chat-join-request.ts:34