GramIO API Reference / @gramio/contexts/dist / UserRating

Class: UserRating

Defined in: contexts/index.d.ts:3601

This object describes the rating of a user based on their Telegram Star spendings.

Documentation

Constructors

Constructor

new UserRating(payload): UserRating

Defined in: contexts/index.d.ts:3603

Parameters

Parameter	Type
payload	TelegramUserRating

Returns

UserRating

Properties

Property	Type	Defined in
payload	TelegramUserRating	contexts/index.d.ts:3602

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

Defined in: contexts/index.d.ts:3604

Returns

string

---

currentLevelRating

Get Signature

get currentLevelRating(): number

Defined in: contexts/index.d.ts:3616

The rating value required to get the current level

Returns

number

---

level

Get Signature

get level(): number

Defined in: contexts/index.d.ts:3608

Current level of the user, indicating their reliability when purchasing digital goods and services

Returns

number

---

nextLevelRating

Get Signature

get nextLevelRating(): number

Defined in: contexts/index.d.ts:3620

Optional. The rating value required to get to the next level; omitted if the maximum level was reached

Returns

number

---

rating

Get Signature

get rating(): number

Defined in: contexts/index.d.ts:3612

Numerical value of the user's rating; the higher the rating, the better

Returns

number