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

Class: BotAccessSettings

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

Describes the access settings of a bot.

Documentation

Constructors

Constructor

new BotAccessSettings(payload): BotAccessSettings

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

Parameters

Parameter	Type
payload	TelegramBotAccessSettings

Returns

BotAccessSettings

Properties

Property	Type	Defined in
payload	TelegramBotAccessSettings	contexts/index.d.ts:1400

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

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

Returns

string

---

addedUsers

Get Signature

get addedUsers(): User[]

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

Optional. The list of other users who have access to the bot if the access is restricted

Returns

User[]

Methods

isAccessRestricted()

isAccessRestricted(): boolean

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

true, if only selected users can access the bot. The bot's owner can always access it.

Returns

boolean