Class ChatContext

Hierarchy

Context<IChat>
- ChatContext
  - DetailedChatContext

Index

Constructors

Properties

#detailedChat _client _source

Accessors

id isForum title type

Methods

createInviteLink exportInviteLink getChat leave setDescription setPhoto setTitle toContext

Constructors

constructor

new ChatContext(_client, _source): ChatContext
Parameters
- _client: Evogram
- _source: IChat
Returns ChatContext
Inherited from Context.constructor
- Defined in src/modules/context/Context.ts:4

Properties

`Private` #detailedChat

#detailedChat: any

`Protected` _client

_client: Evogram

`Protected` _source

_source: IChat

Accessors

id

get id(): number
The ID of the chat.

Returns number
- Defined in src/contexts/Chat/ChatContext.ts:7

isForum

get isForum(): undefined | true
Whether the chat is a forum.

Returns undefined | true
- Defined in src/contexts/Chat/ChatContext.ts:13

title

get title(): string
The title of the chat, or its username, or the concatenation of its first_name and last_name.

Returns string
- Defined in src/contexts/Chat/ChatContext.ts:11

type

get type(): "channel" | "private" | "group" | "supergroup"
The type of the chat.

Returns "channel" | "private" | "group" | "supergroup"
- Defined in src/contexts/Chat/ChatContext.ts:9

Methods

createInviteLink

createInviteLink<T>(params?): Promise<T>
Calls the createChatInviteLink method of the api object to create a new invite link for the chat.
Type Parameters
- T extends Context<IChatInviteLink, T> = ChatInviteLinkContext
Parameters
- Optional params: Partial<ICreateChatInviteLinkParams>
  
  Optional parameters for creating the invite link.
Returns Promise<T>
A Promise that resolves to the new invite link.
- Defined in src/contexts/Chat/ChatContext.ts:29

exportInviteLink

exportInviteLink(): Promise<string>
Calls the exportChatInviteLink method of the api object to export an invite link for the chat.

Returns Promise<string>
A Promise that resolves to the invite link.
- Defined in src/contexts/Chat/ChatContext.ts:20

getChat

getChat<T>(): Promise<T>
Type Parameters
- T extends Context<IChat, T> = DetailedChatContext
Returns Promise<T>
- Defined in src/contexts/Chat/ChatContext.ts:69

leave

leave(): Promise<true>
Calls the leaveChat method of the api object to leave the chat.

Returns Promise<true>
A Promise that resolves to true if the chat was successfully left.
- Defined in src/contexts/Chat/ChatContext.ts:64

setDescription

setDescription(description?): Promise<true>
Calls the setChatDescription method of the api object to set the chat description.
Parameters
- Optional description: string
  
  Optional new description of the chat.
Returns Promise<true>
A Promise that resolves to true if the description was successfully set.
- Defined in src/contexts/Chat/ChatContext.ts:56

setPhoto

setPhoto(photo): Promise<true>
Calls the setChatPhoto method of the api object to set the chat photo.
Parameters
- photo: IInputFile
  
  The photo to set, represented as a URL or Buffer object.
Returns Promise<true>
A Promise that resolves to true if the photo was successfully set.
- Defined in src/contexts/Chat/ChatContext.ts:38

setTitle

setTitle(title): Promise<true>
Calls the setChatTitle method of the api object to set the chat title.
Parameters
- title: string
  
  The new title of the chat.
Returns Promise<true>
A Promise that resolves to true if the title was successfully set.
- Defined in src/contexts/Chat/ChatContext.ts:47

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