Class BotContext

Hierarchy

UserContext
- BotContext

Index

Constructors

constructor

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

Properties

`Private` #member

#member: any

`Protected` _client

_client: Evogram

`Protected` _source

_source: IUser & {
chat_id?: string | number;
}

Accessors

appeal

get appeal(): string
Returns the user's appeal, which is either their username or full name.

Returns string
Inherited from UserContext.appeal
- Defined in src/contexts/Essence/UserContext.ts:24

firstname

get firstname(): string
Returns the user's first name.

Returns string
Inherited from UserContext.firstname
- Defined in src/contexts/Essence/UserContext.ts:10

fullname

get fullname(): string
Returns the user's full name.

Returns string
Inherited from UserContext.fullname
- Defined in src/contexts/Essence/UserContext.ts:29

id

get id(): number
Returns the user's ID.

Returns number
Inherited from UserContext.id
- Defined in src/contexts/Essence/UserContext.ts:8

isBot

get isBot(): boolean
Returns whether the user is a bot.

Returns boolean
Inherited from UserContext.isBot
- Defined in src/contexts/Essence/UserContext.ts:16

isPremium

get isPremium(): undefined | true
Returns whether the user is a premium user.

Returns undefined | true
Inherited from UserContext.isPremium
- Defined in src/contexts/Essence/UserContext.ts:18

language

get language(): undefined | {
code: string;
country: undefined | string;
}
Returns the user's language code and country.

Returns undefined | {
code: string;
country: undefined | string;
}
Inherited from UserContext.language
- Defined in src/contexts/Essence/UserContext.ts:20

lastname

get lastname(): undefined | string
Returns the user's last name.

Returns undefined | string
Inherited from UserContext.lastname
- Defined in src/contexts/Essence/UserContext.ts:12

username

get username(): undefined | string
Returns the user's username.

Returns undefined | string
Inherited from UserContext.username
- Defined in src/contexts/Essence/UserContext.ts:14

Methods

deleteCommands

deleteCommands(params?): Promise<true>
Deletes the bot's commands.
Parameters
- Optional params: IDeleteMyCommandsParams
  
  Optional parameters to customize the behavior of the method.
Returns Promise<true>
A Promise that resolves to true if the operation succeeded.
- Defined in src/contexts/Essence/BotContext.ts:42

getChatMenuButton

getChatMenuButton<T>(params?): Promise<T>
Retrieves the bot's menu button for a chat.
Type Parameters
- T extends object | Context<IMenuButton> = IMenuButton
Parameters
- Optional params: IGetChatMenuButtonParams
  
  Optional parameters to customize the behavior of the method.
Returns Promise<T>
A Promise that resolves to the bot's menu button for the specified chat.
- Defined in src/contexts/Essence/BotContext.ts:60

getCommands

getCommands<T>(params?): Promise<T[]>
Retrieves the current list of the bot's commands.
Type Parameters
- T extends object | Context<IBotCommand> = IBotCommand
Parameters
- Optional params: IGetMyCommandsParams
  
  Optional parameters to customize the behavior of the method.
Returns Promise<T[]>
A Promise that resolves to the current list of the bot's commands.
- Defined in src/contexts/Essence/BotContext.ts:11

getDefaultAdministratorRights

getDefaultAdministratorRights<T>(params?): Promise<T>
Retrieves the bot's default administrator rights.
Type Parameters
- T extends object | Context<IChatAdministratorRights> = IChatAdministratorRights
Parameters
- Optional params: IGetMyDefaultAdministratorRightsParams
  
  Optional parameters to customize the behavior of the method.
Returns Promise<T>
A Promise that resolves to the bot's default administrator rights.
- Defined in src/contexts/Essence/BotContext.ts:78

getMember

getMember<T>(): Promise<null | T>
Gets the user's chat member object.
Type Parameters
- T extends Context<IChatMember, T> = ChatMemberContext
Returns Promise<null | T>
The chat member object or null if the user is not a member of a chat.
Inherited from UserContext.getMember
- Defined in src/contexts/Essence/UserContext.ts:48

getProfilePhotos

getProfilePhotos(params?): Promise<IUserProfilePhotos>
Gets the user's profile photos.
Parameters
- Optional params: Partial<IGetUserProfilePhotosParams>
  
  Additional parameters for the API call.
Returns Promise<IUserProfilePhotos>
The API response.
Inherited from UserContext.getProfilePhotos
- Defined in src/contexts/Essence/UserContext.ts:39

setChatMenuButton

setChatMenuButton(params?): Promise<true>
Sets the bot's menu button for a chat.
Parameters
- Optional params: ISetChatMenuButtonParams
  
  Optional parameters to customize the behavior of the method.
Returns Promise<true>
A Promise that resolves to true if the operation succeeded.
- Defined in src/contexts/Essence/BotContext.ts:51

setCommands

setCommands(commands, params?): Promise<true>
Sets the bot's commands.
Parameters
- commands: IBotCommand[]
  
  An array of IBotCommand objects representing the new list of the bot's commands.
- Optional params: Partial<ISetMyCommandsParams>
  
  Optional parameters to customize the behavior of the method.
Returns Promise<true>
A Promise that resolves to true if the operation succeeded.
- Defined in src/contexts/Essence/BotContext.ts:21
setCommands(params): Promise<true>
Sets the bot's commands.
Parameters
- params: ISetMyCommandsParams
  
  Optional parameters to customize the behavior of the method.
Returns Promise<true>
A Promise that resolves to true if the operation succeeded.
- Defined in src/contexts/Essence/BotContext.ts:28

setDefaultAdministratorRights

setDefaultAdministratorRights(params?): Promise<true>
Sets the bot's default administrator rights.
Parameters
- Optional params: ISetMyDefaultAdministratorRightsParams
  
  Optional parameters to customize the behavior of the method.
Returns Promise<true>
A Promise that resolves to true if the operation succeeded.
- Defined in src/contexts/Essence/BotContext.ts:69

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 UserContext.toContext
- Defined in src/modules/context/Context.ts:16

Class BotContext

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_client: Evogram

_source: IUser & { chat_id?: string | number; }

Returns BotContext

Properties

Private #member

Protected _client

Protected _source

Accessors

appeal

Returns string

firstname

Returns string

fullname

Returns string

id

Returns number

isBot

Returns boolean

isPremium

Returns undefined | true

language

Returns undefined | { code: string; country: undefined | string; }

lastname

Returns undefined | string

username

Returns undefined | string

Methods

deleteCommands

Parameters

Optional params: IDeleteMyCommandsParams

Returns Promise<true>

getChatMenuButton

Type Parameters

T extends object | Context<IMenuButton> = IMenuButton

Parameters

Optional params: IGetChatMenuButtonParams

Returns Promise<T>

getCommands

Type Parameters

T extends object | Context<IBotCommand> = IBotCommand

Parameters

Optional params: IGetMyCommandsParams

Returns Promise<T[]>

getDefaultAdministratorRights

Type Parameters

T extends object | Context<IChatAdministratorRights> = IChatAdministratorRights

Parameters

Optional params: IGetMyDefaultAdministratorRightsParams

Returns Promise<T>

getMember

Type Parameters

T extends Context<IChatMember, T> = ChatMemberContext

Returns Promise<null | T>

getProfilePhotos

Parameters

Optional params: Partial<IGetUserProfilePhotosParams>

Returns Promise<IUserProfilePhotos>

setChatMenuButton

Parameters

Optional params: ISetChatMenuButtonParams

Returns Promise<true>

setCommands

Parameters

commands: IBotCommand[]

Optional params: Partial<ISetMyCommandsParams>

Returns Promise<true>

Parameters

params: ISetMyCommandsParams

Returns Promise<true>

setDefaultAdministratorRights

_source: IUser & {
chat_id?: string | number;
}

`Private` #member

`Protected` _client

`Protected` _source

Returns undefined | {
code: string;
country: undefined | string;
}

`Optional` params: IDeleteMyCommandsParams

`Optional` params: IGetChatMenuButtonParams

`Optional` params: IGetMyCommandsParams

`Optional` params: IGetMyDefaultAdministratorRightsParams

`Optional` params: Partial<IGetUserProfilePhotosParams>

`Optional` params: ISetChatMenuButtonParams

`Optional` params: Partial<ISetMyCommandsParams>

`Optional` params: ISetMyDefaultAdministratorRightsParams