ChatInviteLink class final
ChatInviteLink (chatInviteLink) - basic class
Contains a chat invite link.
- inviteLink: Chat invite link.
- name: Name of the link.
- creatorUserId: User identifier of an administrator created the link.
- date: Point in time (Unix timestamp) when the link was created.
- editDate: Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown.
- expirationDate: Point in time (Unix timestamp) when the link will expire; 0 if never.
- subscriptionPricing: Information about subscription plan that is applied to the users joining the chat by the link; may be null if the link doesn't require subscription (optional).
- memberLimit: The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited. Always 0 if the link requires approval.
- memberCount: Number of chat members, which joined the chat using the link.
- expiredMemberCount: Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only.
- pendingJoinRequestCount: Number of pending join requests created using this link.
- createsJoinRequest: True, if the link only creates join request. If true, total number of joining members will be unlimited.
- isPrimary: True, if the link is primary. Primary invite link can't have name, expiration date, or usage limit. There is exactly one primary invite link for each administrator with can_invite_users right at a given time.
- isRevoked: True, if the link was revoked.
Constructors
- ChatInviteLink({required String inviteLink, required String name, required int creatorUserId, required int date, required int editDate, required int expirationDate, StarSubscriptionPricing? subscriptionPricing, required int memberLimit, required int memberCount, required int expiredMemberCount, required int pendingJoinRequestCount, required bool createsJoinRequest, required bool isPrimary, required bool isRevoked, dynamic extra, int? clientId})
-
ChatInviteLink (chatInviteLink) - basic class
const
-
ChatInviteLink.fromJson(Map<
String, dynamic> json) -
Parse from a json
factory
Properties
- clientId → int?
-
clientId client identifier
final
- createsJoinRequest → bool
-
True, if the link only creates join request. If true, total number of joining members will be unlimited
final
- creatorUserId → int
-
User identifier of an administrator created the link
final
- currentObjectId → String
-
TDLib object type for current class instance
no setteroverride
- date → int
-
Point in time (Unix timestamp) when the link was created
final
- editDate → int
-
Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown
final
- expirationDate → int
-
Point in time (Unix timestamp) when the link will expire; 0 if never
final
- expiredMemberCount → int
-
Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only
final
- extra → dynamic
-
extra callback sign
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- inviteLink → String
-
Chat invite link
final
- isPrimary → bool
-
True, if the link is primary. Primary invite link can't have name, expiration date, or usage limit. There is exactly one primary invite link for each administrator with can_invite_users right at a given time
final
- isRevoked → bool
-
True, if the link was revoked
final
- memberCount → int
-
Number of chat members, which joined the chat using the link
final
- memberLimit → int
-
The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited. Always 0 if the link requires approval
final
- name → String
-
Name of the link
final
- pendingJoinRequestCount → int
-
Number of pending join requests created using this link
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- subscriptionPricing → StarSubscriptionPricing?
-
Information about subscription plan that is applied to the users joining the chat by the link; may be null if the link doesn't require subscription
final
Methods
-
copyWith(
{String? inviteLink, String? name, int? creatorUserId, int? date, int? editDate, int? expirationDate, StarSubscriptionPricing? subscriptionPricing, int? memberLimit, int? memberCount, int? expiredMemberCount, int? pendingJoinRequestCount, bool? createsJoinRequest, bool? isPrimary, bool? isRevoked, dynamic extra, int? clientId}) → ChatInviteLink - Copy model with modified properties.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Convert model to TDLib JSON format
override
-
toString(
) → String -
Convert model to TDLib JSON format, encoded into String.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- defaultObjectId → const String
- TDLib object type