Skip to content

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

Class: ChatPermissions

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

Describes actions that a non-administrator user is allowed to take in a chat.

Documentation

Constructors

Constructor

new ChatPermissions(payload): ChatPermissions

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

Parameters

ParameterType
payloadTelegramChatPermissions

Returns

ChatPermissions

Properties

PropertyTypeDefined in
payloadTelegramChatPermissionscontexts/index.d.ts:3394

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

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

MDN

Returns

string


canAddWebPagePreviews

Get Signature

get canAddWebPagePreviews(): boolean

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

Optional. True, if the user is allowed to add web page previews to their messages

Returns

boolean


canChangeInfo

Get Signature

get canChangeInfo(): boolean

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

Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups

Returns

boolean


canEditTag

Get Signature

get canEditTag(): boolean

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

Optional. True, if the user is allowed to edit their own tag

Returns

boolean


canInviteUsers

Get Signature

get canInviteUsers(): boolean

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

Optional. True, if the user is allowed to invite new users to the chat

Returns

boolean


canManageTopics

Get Signature

get canManageTopics(): boolean

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

Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages

Returns

boolean


canPinMessages

Get Signature

get canPinMessages(): boolean

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

Optional. True, if the user is allowed to pin messages. Ignored in public supergroups

Returns

boolean


canSendAudios

Get Signature

get canSendAudios(): boolean

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

Optional. True, if the user is allowed to send audios

Returns

boolean


canSendDocuments

Get Signature

get canSendDocuments(): boolean

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

Optional. True, if the user is allowed to send documents

Returns

boolean


canSendMessages

Get Signature

get canSendMessages(): boolean

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

Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues

Returns

boolean


canSendOtherMessages

Get Signature

get canSendOtherMessages(): boolean

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

Optional. True, if the user is allowed to send animations, games, stickers and use inline bots

Returns

boolean


canSendPhotos

Get Signature

get canSendPhotos(): boolean

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

Optional. True, if the user is allowed to send photos

Returns

boolean


canSendPolls

Get Signature

get canSendPolls(): boolean

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

Optional. True, if the user is allowed to send polls

Returns

boolean


canSendVideoNotes

Get Signature

get canSendVideoNotes(): boolean

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

Optional. True, if the user is allowed to send video notes

Returns

boolean


canSendVideos

Get Signature

get canSendVideos(): boolean

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

Optional. True, if the user is allowed to send videos

Returns

boolean


canSendVoiceNotes

Get Signature

get canSendVoiceNotes(): boolean

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

Optional. True, if the user is allowed to send voice notes

Returns

boolean