Class ChatInviteLinkContext

Hierarchy

Context<IChatInviteLink & {
chat_id: number | string;
}>
- ChatInviteLinkContext

Index

Constructors

Properties

_client _source creator expireDate

Accessors

createsJoinRequest isPrimary isRevoked link memberLimit name pendingJoinRequestCount

Methods

edit revoke toContext

Constructors

constructor

new ChatInviteLinkContext(_client, _source): ChatInviteLinkContext
Parameters
- _client: Evogram
- _source: IChatInviteLink & {
  chat_id: string | number;
  }
Returns ChatInviteLinkContext
Inherited from Context.constructor
- Defined in src/modules/context/Context.ts:4

Properties

`Protected` _client

_client: Evogram

`Protected` _source

_source: IChatInviteLink & {
chat_id: string | number;
}

creator

creator: UserContext = ...

The user who created the chat invite link.

expireDate

expireDate: undefined | Date = ...

The date and time when the chat invite link will expire, or undefined if it does not expire.

Accessors

createsJoinRequest

get createsJoinRequest(): boolean
Whether the chat invite link creates a join request for users who follow it.

Returns boolean
- Defined in src/contexts/Chat/ChatInviteLinkContext.ts:14

isPrimary

get isPrimary(): boolean
Whether the chat invite link is the primary invite link for the chat.

Returns boolean
- Defined in src/contexts/Chat/ChatInviteLinkContext.ts:16

isRevoked

get isRevoked(): boolean
Whether the chat invite link has been revoked.

Returns boolean
- Defined in src/contexts/Chat/ChatInviteLinkContext.ts:18

link

get link(): string
The chat invite link.

Returns string
- Defined in src/contexts/Chat/ChatInviteLinkContext.ts:12

memberLimit

get memberLimit(): undefined | number
The maximum number of members that can join the chat using the chat invite link.

Returns undefined | number
- Defined in src/contexts/Chat/ChatInviteLinkContext.ts:22

name

get name(): undefined | string
- The chat's name, if the chat is public and has a username.
Returns undefined | string
- Defined in src/contexts/Chat/ChatInviteLinkContext.ts:20

pendingJoinRequestCount

get pendingJoinRequestCount(): undefined | number
The number of users who have pending join requests for the chat.

Returns undefined | number
- Defined in src/contexts/Chat/ChatInviteLinkContext.ts:24

Methods

edit

edit<T>(params): Promise<T>
Edits the chat invite link.
Type Parameters
- T extends Context<IChatInviteLink, T> = ChatInviteLinkContext
Parameters
- params: Partial<IEditChatInviteLinkParams>
Returns Promise<T>
- Defined in src/contexts/Chat/ChatInviteLinkContext.ts:28

revoke

revoke<T>(): Promise<T>
Revokes the chat invite link.
Type Parameters
- T extends Context<IChatInviteLink, T> = ChatInviteLinkContext
Returns Promise<T>
- Defined in src/contexts/Chat/ChatInviteLinkContext.ts:33

toContext

toContext<TContext>(): TContext
Converts the source object to a context object of a given type.

Example
```
client.updates.on("message", message => {
        const user = message.user.toContext<CustomUserContext>();
        // Now user works correctly with your context
    })
```
Type Parameters
- TContext extends object
  
  Generic type parameter for the context object.
Returns TContext
The context object.
Inherited from Context.toContext
- Defined in src/modules/context/Context.ts:16

Generated using TypeDoc