Class TelegramUserProfile

Hierarchy

TelegramUserProfile

Implements

MachinatProfile
MarshallableInstance<TelegramUserProfileValue>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TelegramUserProfile(rawUser: RawUser, avatarUrl?: string): TelegramUserProfile

- Defined in packages/telegram/src/UserProfile.ts:25
Parameters
- rawUser: RawUser
- Optional avatarUrl: string
Returns TelegramUserProfile

Properties

avatarUrl

avatarUrl: undefined | string

data

platform

platform: "telegram" = TELEGRAM

timeZone

timeZone: undefined = undefined

type

type: "user" = ...

Static typeName

typeName: string = 'TelegramUserProfile'

Accessors

firstName

get firstName(): undefined | string

Implementation of MachinatProfile.firstName
- Defined in packages/telegram/src/UserProfile.ts:42
User's or bot's first name

Returns undefined | string

id

get id(): number

- Defined in packages/telegram/src/UserProfile.ts:31
Id of the user or bot

Returns number

isBot

get isBot(): boolean

- Defined in packages/telegram/src/UserProfile.ts:57
If this user is a bot

Returns boolean

languageCode

get languageCode(): undefined | string

Implementation of MachinatProfile.languageCode
- Defined in packages/telegram/src/UserProfile.ts:62
IETF language tag of the user's language

Returns undefined | string

lastName

get lastName(): undefined | string

Implementation of MachinatProfile.lastName
- Defined in packages/telegram/src/UserProfile.ts:47
User's or bot's last name

Returns undefined | string

name

get name(): string

Implementation of MachinatProfile.name
- Defined in packages/telegram/src/UserProfile.ts:36
Display name of the user or bot

Returns string

username

get username(): undefined | string

- Defined in packages/telegram/src/UserProfile.ts:52
User's or bot's username

Returns undefined | string

Methods

toJSONValue

toJSONValue(): TelegramUserProfileValue

Implementation of MarshallableInstance.toJSONValue
- Defined in packages/telegram/src/UserProfile.ts:66
Returns TelegramUserProfileValue

typeName

typeName(): string

Implementation of MarshallableInstance.typeName
- Defined in packages/telegram/src/UserProfile.ts:72
Returns string

Static fromJSONValue

fromJSONValue(value: TelegramUserProfileValue): TelegramUserProfile

- Defined in packages/telegram/src/UserProfile.ts:15
Parameters
- value: TelegramUserProfileValue
Returns TelegramUserProfile

Generated using TypeDoc