Class ChatJoinRequest

Hierarchy (view full)

Constructors

constructor

Properties

author bio? chat createdUnixTime inviteLink? userChatId

Accessors

client createdAt createdTimestamp

Methods

_clone _patch _update approveJoinRequest declineJoinRequest toJSON valueOf

Constructors

constructor

Properties

author

author: User

User that sent the join request

Optionalbio

bio?: string

Bio of the user

chat

chat: Chat

Chat to which the request was sent

createdUnixTime

createdUnixTime: number

Date the request was sent in Unix time

OptionalinviteLink

inviteLink?: ChatInviteLink

Chat invite link that was used by the user to send the join request

userChatId

userChatId: string

Identifier of a private chat with the user who sent the join request. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.

Accessors

client

createdAt

  • get createdAt(): Date

  • Date the request was sent

    Returns Date

createdTimestamp

  • get createdTimestamp(): number

  • Return the timestamp request was sent, in milliseconds

    Returns number

Methods

Protected_clone

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

Protected_patch

  • _patch(data): Record<string, any>
  • Protected

    Patches the current instance with new data

    Parameters

    • data: Record<string, any>

      The data to patch the instance with

    Returns Record<string, any>

    The patched data

Protected_update

  • _update(data): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

approveJoinRequest

  • approveJoinRequest(): Promise<true>

  • Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right.

    Returns Promise<true>

    Returns True on success.

declineJoinRequest

  • declineJoinRequest(): Promise<true>

  • Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right.

    Returns Promise<true>

    Returns True on success.

toJSON

  • toJSON(propsRecursive?, ...props): Record<string, any>

  • Flatten an object. Any properties that are collections will get converted to an array of keys.

    Parameters

    • OptionalpropsRecursive: boolean

      Optional. If true, calls toJSON method on nested objects.

    • Rest...props: Record<string, string | boolean>[]

      Optional. Specific properties to include/exclude, or rename.

    Returns Record<string, any>

    Flattened object.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods