GramIO API Reference / @gramio/contexts/dist / SharedUser
Class: SharedUser
Defined in: contexts/index.d.ts:3205
This object contains information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button.
Constructors
Constructor
new SharedUser(
payload):SharedUser
Defined in: contexts/index.d.ts:3207
Parameters
| Parameter | Type |
|---|---|
payload | TelegramSharedUser |
Returns
SharedUser
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramSharedUser | contexts/index.d.ts:3206 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:3209
Returns
string
firstName
Get Signature
get firstName():
string
Defined in: contexts/index.d.ts:3213
First name of the user, if the name was requested by the bot
Returns
string
lastName
Get Signature
get lastName():
string
Defined in: contexts/index.d.ts:3215
Last name of the user, if the name was requested by the bot
Returns
string
photo
Get Signature
get photo():
PhotoSize[]
Defined in: contexts/index.d.ts:3219
Available sizes of the chat photo, if the photo was requested by the bot
Returns
userId
Get Signature
get userId():
number
Defined in: contexts/index.d.ts:3211
Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.
Returns
number
username
Get Signature
get username():
string
Defined in: contexts/index.d.ts:3217
Username of the user, if the username was requested by the bot
Returns
string