class ChatInviteLink

Represents an invite link for a chat.

Methods

__construct(string $invite_link, User $creator, bool $creates_join_request, bool $is_primary, bool $is_revoked, string|null $name = null, int|null $expire_date = null, int|null $member_limit = null, int|null $pending_join_request_count = null)

No description

string
getInviteLink()

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

getCreator()

Creator of the link.

bool
getCreatesJoinRequest()

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

bool
getIsPrimary()

True, if the link is primary.

bool
getIsRevoked()

True, if the link is revoked.

string|null
getName()

Optional. Invite link name.

int|null
getExpireDate()

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

int|null
getMemberLimit()

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

int|null
getPendingJoinRequestCount()

Optional. Number of pending join requests created using this link.

Details

at line 21
__construct(string $invite_link, User $creator, bool $creates_join_request, bool $is_primary, bool $is_revoked, string|null $name = null, int|null $expire_date = null, int|null $member_limit = null, int|null $pending_join_request_count = null)

No description

Parameters

string $invite_link
User $creator
bool $creates_join_request
bool $is_primary
bool $is_revoked
string|null $name
int|null $expire_date
int|null $member_limit
int|null $pending_join_request_count

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

Return Value

string

at line 45
User getCreator()

Creator of the link.

Return Value

User

at line 53
bool getCreatesJoinRequest()

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

Return Value

bool

at line 61
bool getIsPrimary()

True, if the link is primary.

Return Value

bool

at line 69
bool getIsRevoked()

True, if the link is revoked.

Return Value

bool

at line 77
string|null getName()

Optional. Invite link name.

Return Value

string|null

at line 85
int|null getExpireDate()

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

Return Value

int|null

at line 93
int|null getMemberLimit()

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

Return Value

int|null

at line 101
int|null getPendingJoinRequestCount()

Optional. Number of pending join requests created using this link.

Return Value

int|null