Class ChannelContext

Constructors

constructor

new ChannelContext(ctx: BaseContext): ChannelContext
Parameters
- ctx: BaseContext
Returns ChannelContext
- Defined in core/context/channel-context.ts:40

Methods

answerChatJoinRequestQuery

answerChatJoinRequestQuery(
result: "approve" | "decline" | "queue",
queryId?: string,
): Promise<boolean>
Process a received chat join request query
Parameters
- result: "approve" | "decline" | "queue"
  Outcome ('approve', 'decline', or 'queue')
- OptionalqueryId: string
  Optional query ID. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:76

approveChatJoinRequest

approveChatJoinRequest(userId: number): Promise<boolean>
Approve a request to join the chat
Parameters
- userId: number
  User ID
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:93

approveSuggestedPost

approveSuggestedPost(
messageId?: number,
options?: Omit<ApproveSuggestedPostParams, "chat_id" | "message_id">,
): Promise<boolean>
Approve a suggested post to publish it in the channel
Parameters
- OptionalmessageId: number
  Suggested post message ID. If omitted, resolved from the update.
- Optionaloptions: Omit<ApproveSuggestedPostParams, "chat_id" | "message_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:216

banChatMember

banChatMember(
userId: number,
options?: Omit<BanChatMemberParams, "chat_id" | "user_id">,
): Promise<boolean>
Ban a user from the channel (kick and block)
Parameters
- userId: number
  User ID
- Optionaloptions: Omit<BanChatMemberParams, "chat_id" | "user_id">
  Additional ban settings (e.g. until_date)
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:583

banChatSenderChat

banChatSenderChat(
senderChatId: number,
options?: Omit<BanChatSenderChatParams, "chat_id" | "sender_chat_id">,
): Promise<boolean>
Ban a channel from posting comments/interacting (spammers)
Parameters
- senderChatId: number
  Sender channel ID to ban
- Optionaloptions: Omit<BanChatSenderChatParams, "chat_id" | "sender_chat_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:617

createInviteLink

createInviteLink(
options?: Omit<CreateChatInviteLinkParams, "chat_id">,
): Promise<ChatInviteLink>
Create an additional invite link
Parameters
- Optionaloptions: Omit<CreateChatInviteLinkParams, "chat_id">
  Additional parameters
Returns Promise<ChatInviteLink>
Promise<ChatInviteLink>
- Defined in core/context/channel-context.ts:168

createSubscriptionInviteLink

createSubscriptionInviteLink(
    subscriptionPeriod: number,
    subscriptionPrice: number,
    options?: Omit<
        CreateChatSubscriptionInviteLinkParams,
        "chat_id"
        | "subscription_period"
        | "subscription_price",
    >,
): Promise<ChatInviteLink>
Create a subscription invite link for the channel (recurrent payment in Stars)
Parameters
- subscriptionPeriod: number
  Period in seconds (currently 2592000 for 30 days)
- subscriptionPrice: number
  Amount of Stars per period
- Optionaloptions: Omit<
      CreateChatSubscriptionInviteLinkParams,
      "chat_id"
      | "subscription_period"
      | "subscription_price",
  >
  Additional parameters
Returns Promise<ChatInviteLink>
Promise<ChatInviteLink>
- Defined in core/context/channel-context.ts:123

declineChatJoinRequest

declineChatJoinRequest(userId: number): Promise<boolean>
Decline a request to join the chat
Parameters
- userId: number
  User ID
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:105

declineSuggestedPost

declineSuggestedPost(
messageId?: number,
options?: Omit<DeclineSuggestedPostParams, "chat_id" | "message_id">,
): Promise<boolean>
Decline a suggested post
Parameters
- OptionalmessageId: number
  Suggested post message ID. If omitted, resolved from the update.
- Optionaloptions: Omit<DeclineSuggestedPostParams, "chat_id" | "message_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:237

deleteMessage

deleteMessage(messageId?: number): Promise<boolean>
Delete a post from the channel
Parameters
- OptionalmessageId: number
  Message ID to delete. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:486

deleteMessages

deleteMessages(messageIds: number[]): Promise<boolean>
Delete multiple messages from the channel
Parameters
- messageIds: number[]
  Array of message IDs
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:502

editInviteLink

editInviteLink(
inviteLink: string,
options?: Omit<EditChatInviteLinkParams, "chat_id" | "invite_link">,
): Promise<ChatInviteLink>
Edit an invite link created by the bot
Parameters
- inviteLink: string
  Invite link to edit
- Optionaloptions: Omit<EditChatInviteLinkParams, "chat_id" | "invite_link">
  Additional parameters
Returns Promise<ChatInviteLink>
Promise<ChatInviteLink>
- Defined in core/context/channel-context.ts:183

editMessageCaption

editMessageCaption(
    caption: string,
    messageId?: number,
    options?: Omit<
        EditMessageCaptionParams,
        "caption"
        | "chat_id"
        | "message_id",
    >,
): Promise<boolean | Message>
Edit the caption of a message
Parameters
- caption: string
  New message caption
- OptionalmessageId: number
  Message ID to edit. If omitted, resolved from the update.
- Optionaloptions: Omit<EditMessageCaptionParams, "caption" | "chat_id" | "message_id">
  Additional parameters
Returns Promise<boolean | Message>
Promise<Message | boolean>
- Defined in core/context/channel-context.ts:440

editMessageMedia

editMessageMedia(
    media: InputMedia,
    messageId?: number,
    options?: Omit<EditMessageMediaParams, "chat_id" | "message_id" | "media">,
): Promise<boolean | Message>
Edit the media elements of a message
Parameters
- media: InputMedia
  New media content
- OptionalmessageId: number
  Message ID to edit. If omitted, resolved from the update.
- Optionaloptions: Omit<EditMessageMediaParams, "chat_id" | "message_id" | "media">
  Additional parameters
Returns Promise<boolean | Message>
Promise<Message | boolean>
- Defined in core/context/channel-context.ts:464

editMessageText

editMessageText(
    text: string,
    messageId?: number,
    options?: Omit<EditMessageTextParams, "text" | "chat_id" | "message_id">,
): Promise<boolean | Message>
Edit the text of a message
Parameters
- text: string
  New message text
- OptionalmessageId: number
  Message ID to edit. If omitted, resolved from the update.
- Optionaloptions: Omit<EditMessageTextParams, "text" | "chat_id" | "message_id">
  Additional parameters
Returns Promise<boolean | Message>
Promise<Message | boolean>
- Defined in core/context/channel-context.ts:416

editSubscriptionInviteLink

editSubscriptionInviteLink(
    inviteLink: string,
    options?: Omit<
        EditChatSubscriptionInviteLinkParams,
        "chat_id"
        | "invite_link",
    >,
): Promise<ChatInviteLink>
Edit a subscription invite link
Parameters
- inviteLink: string
  Invite link to edit
- Optionaloptions: Omit<EditChatSubscriptionInviteLinkParams, "chat_id" | "invite_link">
  Additional parameters
Returns Promise<ChatInviteLink>
Promise<ChatInviteLink>
- Defined in core/context/channel-context.ts:142

exportInviteLink

exportInviteLink(): Promise<string>
Export the chat invite link

Returns Promise<string>
Promise<string>
- Defined in core/context/channel-context.ts:157

getMemberCount

getMemberCount(): Promise<number>
Get the number of members in the channel.

Returns Promise<number>
Promise<number>
- Defined in core/context/channel-context.ts:644

pinChatMessage

pinChatMessage(
messageId?: number,
options?: Omit<PinChatMessageParams, "chat_id" | "message_id">,
): Promise<boolean>
Pin a message in the channel header
Parameters
- OptionalmessageId: number
  Message ID to pin. If omitted, resolved from the update.
- Optionaloptions: Omit<PinChatMessageParams, "chat_id" | "message_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:515

promoteChatMember

promoteChatMember(
userId: number,
options?: Omit<PromoteChatMemberParams, "chat_id" | "user_id">,
): Promise<boolean>
Promote or demote a user in the channel (manage administrators)
Parameters
- userId: number
  User ID
- Optionaloptions: Omit<PromoteChatMemberParams, "chat_id" | "user_id">
  Administrator permissions
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:566

revokeInviteLink

revokeInviteLink(inviteLink: string): Promise<ChatInviteLink>
Revoke an invite link created by the bot
Parameters
- inviteLink: string
  Invite link to revoke
Returns Promise<ChatInviteLink>
Promise<ChatInviteLink>
- Defined in core/context/channel-context.ts:199

sendAnimation

sendAnimation(
animation: string | InputFile,
options?: Omit<SendAnimationParams, "chat_id" | "animation">,
): Promise<Message>
Send an animation/GIF
Parameters
- animation: string | InputFile
  Animation URL or file_id
- Optionaloptions: Omit<SendAnimationParams, "chat_id" | "animation">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/channel-context.ts:398

sendAudio

sendAudio(
audio: string | InputFile,
options?: Omit<SendAudioParams, "chat_id" | "audio">,
): Promise<Message>
Send an audio file
Parameters
- audio: string | InputFile
  Audio URL or file_id
- Optionaloptions: Omit<SendAudioParams, "chat_id" | "audio">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/channel-context.ts:347

sendChatJoinRequestWebApp

sendChatJoinRequestWebApp(webAppUrl: string, queryId?: string): Promise<boolean>
Show a Mini App to the user before deciding on their join request
Parameters
- webAppUrl: string
  Mini App URL to be opened
- OptionalqueryId: string
  Optional query ID. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:58

sendDocument

sendDocument(
document: string | InputFile,
options?: Omit<SendDocumentParams, "chat_id" | "document">,
): Promise<Message>
Send a document/file
Parameters
- document: string | InputFile
  Document URL or file_id
- Optionaloptions: Omit<SendDocumentParams, "chat_id" | "document">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/channel-context.ts:364

sendMediaGroup

sendMediaGroup(
    media: (
        | InputMediaAudio
        | InputMediaDocument
        | InputMediaLivePhoto
        | InputMediaPhoto
        | InputMediaVideo
    )[],
    options?: Omit<SendMediaGroupParams, "chat_id" | "media">,
): Promise<Message[]>
Send a group of photos or videos as an album
Parameters
- media: (
      | InputMediaAudio
      | InputMediaDocument
      | InputMediaLivePhoto
      | InputMediaPhoto
      | InputMediaVideo
  )[]
  Array of media items
- Optionaloptions: Omit<SendMediaGroupParams, "chat_id" | "media">
  Additional parameters
Returns Promise<Message[]>
Promise<Message[]>
- Defined in core/context/channel-context.ts:330

sendMessage

sendMessage(
text: string,
options?: Omit<SendMessageParams, "text" | "chat_id">,
): Promise<Message>
Send a text message to the channel
Parameters
- text: string
  Message text
- Optionaloptions: Omit<SendMessageParams, "text" | "chat_id">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/channel-context.ts:279

sendPhoto

sendPhoto(
photo: string | InputFile,
options?: Omit<SendPhotoParams, "chat_id" | "photo">,
): Promise<Message>
Send a photo to the channel
Parameters
- photo: string | InputFile
  Photo URL or file_id
- Optionaloptions: Omit<SendPhotoParams, "chat_id" | "photo">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/channel-context.ts:296

sendRichMessage

sendRichMessage(
    richMessage: (
        | { html: string; markdown?: undefined }
        | { html?: undefined; markdown: string }
    ) & Pick<InputRichMessage, "is_rtl" | "skip_entity_detection">,
    options?: Omit<SendRichMessageParams, "chat_id" | "rich_message">,
): Promise<Message>
Send a rich message using HTML or Markdown
Parameters
- richMessage: (
  | { html: string; markdown?: undefined }
  | { html?: undefined; markdown: string }
  ) & Pick<InputRichMessage, "is_rtl" | "skip_entity_detection">
  The rich message options
- Optionaloptions: Omit<SendRichMessageParams, "chat_id" | "rich_message">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/channel-context.ts:262

sendVideo

sendVideo(
video: string | InputFile,
options?: Omit<SendVideoParams, "chat_id" | "video">,
): Promise<Message>
Send a video to the channel
Parameters
- video: string | InputFile
  Video URL or file_id
- Optionaloptions: Omit<SendVideoParams, "chat_id" | "video">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/channel-context.ts:313

sendVoice

sendVoice(
voice: string | InputFile,
options?: Omit<SendVoiceParams, "chat_id" | "voice">,
): Promise<Message>
Send a voice message
Parameters
- voice: string | InputFile
  Voice URL or file_id
- Optionaloptions: Omit<SendVoiceParams, "chat_id" | "voice">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/channel-context.ts:381

unbanChatMember

unbanChatMember(
userId: number,
options?: Omit<UnbanChatMemberParams, "chat_id" | "user_id">,
): Promise<boolean>
Unban a user from the channel
Parameters
- userId: number
  User ID
- Optionaloptions: Omit<UnbanChatMemberParams, "chat_id" | "user_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:600

unbanChatSenderChat

unbanChatSenderChat(senderChatId: number): Promise<boolean>
Unban a previously banned channel
Parameters
- senderChatId: number
  Sender channel ID to unban
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:633

unpinAllChatMessages

unpinAllChatMessages(): Promise<boolean>
Unpin all pinned messages in the channel

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:550

unpinChatMessage

unpinChatMessage(messageId?: number): Promise<boolean>
Unpin a message from the channel header
Parameters
- OptionalmessageId: number
  Optional message ID to unpin. If omitted, the latest pinned message is unpinned.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/channel-context.ts:535

Class ChannelContext

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ChannelContext

Methods

answerChatJoinRequestQuery

Parameters

Returns Promise<boolean>

approveChatJoinRequest

Parameters

Returns Promise<boolean>

approveSuggestedPost

Parameters

Returns Promise<boolean>

banChatMember

Parameters

Returns Promise<boolean>

banChatSenderChat

Parameters

Returns Promise<boolean>

createInviteLink

Parameters

Returns Promise<ChatInviteLink>

createSubscriptionInviteLink

Parameters

Returns Promise<ChatInviteLink>

declineChatJoinRequest

Parameters

Returns Promise<boolean>

declineSuggestedPost

Parameters

Returns Promise<boolean>

deleteMessage

Parameters

Returns Promise<boolean>

deleteMessages

Parameters

Returns Promise<boolean>

editInviteLink

Parameters

Returns Promise<ChatInviteLink>

editMessageCaption

Parameters

Returns Promise<boolean | Message>

editMessageMedia

Parameters

Returns Promise<boolean | Message>

editMessageText

Parameters

Returns Promise<boolean | Message>

editSubscriptionInviteLink

Parameters

Returns Promise<ChatInviteLink>

exportInviteLink

Returns Promise<string>

getMemberCount

Returns Promise<number>

pinChatMessage

Parameters

Returns Promise<boolean>

promoteChatMember

Parameters

Returns Promise<boolean>

revokeInviteLink

Parameters

Returns Promise<ChatInviteLink>

sendAnimation

Parameters

Returns Promise<Message>

sendAudio

Parameters

Returns Promise<Message>

sendChatJoinRequestWebApp

Parameters

Returns Promise<boolean>

sendDocument