Struct tgbot::types::ChatInviteLink

pub struct ChatInviteLink {
    pub creates_join_request: bool,
    pub creator: User,
    pub invite_link: String,
    pub is_primary: bool,
    pub is_revoked: bool,
    pub expire_date: Option<Integer>,
    pub member_limit: Option<Integer>,
    pub name: Option<String>,
    pub pending_join_request_count: Option<Integer>,
}

Represents an invite link for a chat.

Fields

creates_join_request: bool

Indicates whether users joining the chat via the link need to be approved by chat administrators.

creator: User

The creator of the link.

invite_link: String

The invite link.

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

is_primary: bool

Indicates whether the link is primary.

is_revoked: bool

Indicates whether the link is revoked.

expire_date: Option<Integer>

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

member_limit: Option<Integer>

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

name: Option<String>

The name of the invite link.

pending_join_request_count: Option<Integer>

The number of pending join requests created using this link.

Implementations

impl ChatInviteLink

pub fn new<T>(invite_link: T, creator: User) -> Self

where T: Into<String>,

Creates a new ChatInviteLink.

Arguments

• invite_link - Invite link.
• creator - Creator of the link.

pub fn with_creates_join_request(self, value: bool) -> Self

Sets a new value for a creates_join_request flag.

Arguments

• value - Indicates whether users joining the chat via the link need to be approved by chat administrators.

pub fn with_expire_date(self, value: Integer) -> Self

Sets a new expiration date.

Arguments

• value - The point in time (Unix timestamp) when the link will expire or has been expired.

pub fn with_is_primary(self, value: bool) -> Self

Sets a new value for an is_primary flag.

Arguments

• value - Indicates whether the link is primary.

pub fn with_is_revoked(self, value: bool) -> Self

Sets a new value for an is_revoked flag.

Arguments

• value - Indicates whether the link is revoked.

pub fn with_member_limit(self, value: Integer) -> Self

Sets a new member limit

Arguments

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

pub fn with_name<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new name of the invite link.

Arguments

• value - The name of the invite link.

pub fn with_pending_join_request_count(self, value: Integer) -> Self

Sets a new pending join requests count.

Arguments

• value - The number of pending join requests created using this link.

Trait Implementations

impl Clone for ChatInviteLink

fn clone(&self) -> ChatInviteLink

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChatInviteLink

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatInviteLink

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatInviteLink

fn eq(&self, other: &ChatInviteLink) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ChatInviteLink

fn partial_cmp(&self, other: &ChatInviteLink) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ChatInviteLink

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChatInviteLink