ChatInviteLink class abstract

Represents an invite link for a chat.

Available extensions
Annotations
  • @freezed

Constructors

ChatInviteLink.new({@JsonKey(name: 'invite_link') required String inviteLink, @JsonKey(name: 'creator') User? creator, @JsonKey(name: 'creates_join_request') bool? createsJoinRequest, @JsonKey(name: 'is_primary') bool? isPrimary, @JsonKey(name: 'is_revoked') bool? isRevoked, @JsonKey(name: 'name') String? name, @JsonKey(name: 'expire_date') int? expireDate, @JsonKey(name: 'member_limit') int? memberLimit, @JsonKey(name: 'pending_member_count') int? pendingMemberCount})
Creates a new ChatInviteLink object.
const
factory
ChatInviteLink.fromJson(Map<String, dynamic> json)
Creates a new ChatInviteLink object from json.
factory

Properties

copyWith → $ChatInviteLinkCopyWith<ChatInviteLink>
Create a copy of ChatInviteLink with the given fields replaced by the non-null parameter values.
no setterinherited
createsJoinRequest bool?
True, if users joining the chat via the link need to be approved by chat administrators
no setterinherited
creator User?
Creator of the link
no setterinherited
expireDate int?
Optional. Point in time (Unix timestamp) when the link will expire or has been expired
no setterinherited
expireDateTime DateTime?

Available on ChatInviteLink, provided by the ChatInviteLinkExt extension

Returns the expiry date as DateTime object. Returns null if the link doesn't expire.
no setter
hashCode int
The hash code for this object.
no setterinherited
The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.
no setterinherited
isPrimary bool?
True, if the link is primary
no setterinherited
isRevoked bool?
True, if the link is revoked
no setterinherited
memberLimit int?
Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
no setterinherited
name String?
Optional. Invite link name
no setterinherited
pendingMemberCount int?
Optional. Number of pending join requests created using this link
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Serializes this ChatInviteLink to a JSON map.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited