Class UserContext

Hierarchy

Context<IUser & {
chat_id?: number | string;
}>
- UserContext
  - BotContext

Index

Constructors

Properties

#member _client _source

Accessors

appeal firstname fullname id isBot isPremium language lastname username

Methods

getMember getProfilePhotos toContext

Constructors

constructor

new UserContext(_client, _source): UserContext
Parameters
- _client: Evogram
- _source: IUser & {
  chat_id?: string | number;
  }
Returns UserContext
Inherited from Context.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
- Defined in src/contexts/Essence/UserContext.ts:24

firstname

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

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

fullname

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

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

id

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

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

isBot

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

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

isPremium

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

Returns undefined | true
- 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;
}
- Defined in src/contexts/Essence/UserContext.ts:20

lastname

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

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

username

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

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

Methods

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.
- 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.
- Defined in src/contexts/Essence/UserContext.ts:39

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