Class ChatMember

constructor

• new ChatMember(
      raw: TypeChatParticipant | TypeChannelParticipant,
      _peers: PeersIndex,
  ): ChatMember

  Parameters

  • raw: TypeChatParticipant | TypeChannelParticipant
  • _peers: PeersIndex

  Returns ChatMember

Readonly_peers

Readonlyraw

invitedBy

• get invitedBy(): User | null

  Information about whoever invited this member to the chat.

  Only available in the following cases:

  • user is yourself
  • chat is a legacy group
  • chat is a supergroup/channel, and user is an admin

  Returns User | null

isMember

• get isMember(): boolean

  Whether this member is a part of the chat now.

  Makes sense only when status = restricted or staus = banned

  Returns boolean

joinedDate

• get joinedDate(): Date | null

  Date when the user has joined the chat.

  Not available for creators and left members

  Returns Date | null

permissions

• get permissions(): RawChatAdminRights | null

  For admins and creator of supergroup/channels, list of their admin permissions.

  Also contains whether this admin is anonymous.

  Returns RawChatAdminRights | null

promotedBy

• get promotedBy(): User | null

  Information about whoever promoted this admin.

  Only available if status = admin.

  Returns User | null

restrictedBy

• get restrictedBy(): User | null

  Information about whoever restricted this user.

  Only available if status = restricted or status = banned

  Returns User | null

restrictions

• get restrictions(): ChatPermissions | null

  For restricted and banned users, information about the restrictions

  Returns ChatPermissions | null

status

• get status(): ChatMemberStatus

  Get the chat member status

  Returns ChatMemberStatus

subscriptionUntilDate

• get subscriptionUntilDate(): Date | null

  If this member subscribed to a channel using Telegram Stars, this field will contain the date when the subscription will expire

  Returns Date | null

title

• get title(): string | null

  Custom title (for creators and admins).

  null for non-admins and in case custom title is not set.

  Returns string | null

user

• get user(): User

  Information about the user

  Returns User