Class ChatMember

constructor

• new ChatMember(raw, _peers): ChatMember

• Parameters

  • raw: TypeChatParticipant | TypeChannelParticipant
  • _peers: PeersIndex

  Returns ChatMember

Readonly_peers

Readonlyraw

invitedBy

• get invitedBy(): null | User

• 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 null | User

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(): null | Date

• Date when the user has joined the chat.

  Not available for creators and left members

  Returns null | Date

permissions

• get permissions(): null | RawChatAdminRights

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

  Also contains whether this admin is anonymous.

  Returns null | RawChatAdminRights

promotedBy

• get promotedBy(): null | User

• Information about whoever promoted this admin.

  Only available if status = admin.

  Returns null | User

restrictedBy

• get restrictedBy(): null | User

• Information about whoever restricted this user.

  Only available if status = restricted or status = banned

  Returns null | User

restrictions

• get restrictions(): null | ChatPermissions

• For restricted and banned users, information about the restrictions

  Returns null | ChatPermissions

status

• get status(): ChatMemberStatus

• Get the chat member status

  Returns ChatMemberStatus

subscriptionUntilDate

• get subscriptionUntilDate(): null | Date

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

  Returns null | Date

title

• get title(): null | string

• Custom title (for creators and admins).

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

  Returns null | string

user

• get user(): User

• Information about the user

  Returns User