Class ChatInviteLink

Hierarchy (view full)

Constructors

constructor

Properties

createsRequest creator expiredUnixTime? limit? link name? primary requestsCount? revoked subscriptionPeriod? subscriptionPrice?

Accessors

client expiredAt expiredTimestamp

Methods

_clone _patch _update toJSON valueOf

Constructors

constructor

Properties

createsRequest

createsRequest: boolean

True, if users joining the chat via the link need to be approved by chat administrators

creator

creator: User

Creator of the link

OptionalexpiredUnixTime

expiredUnixTime?: number

Point in time (Unix timestamp) when the link will expire or has been expired

Optionallimit

limit?: number

The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

link

link: string

The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with "...".

Optionalname

name?: string

Invite link name

primary

primary: boolean

True, if the link is primary

OptionalrequestsCount

requestsCount?: number

Number of pending join requests created using this link

revoked

revoked: boolean

True, if the link is revoked

OptionalsubscriptionPeriod

subscriptionPeriod?: number

The number of seconds the subscription will be active for before the next payment

OptionalsubscriptionPrice

subscriptionPrice?: number

The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link

Accessors

client

expiredAt

  • get expiredAt(): null | Date

  • Point in time when the link will expire or has been expired

    Returns null | Date

expiredTimestamp

  • get expiredTimestamp(): null | number

  • Return the timestamp link will expire or has been expired, in milliseconds

    Returns null | 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

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