Class SharedWidgetQueryContext

Context of a widget query update originated from a forwarded copy of a shared widget.

This is a subclass of SharedWidgetQuery, so all its fields are also available.

Hierarchy (View Summary)

SharedWidgetQuery
- SharedWidgetQueryContext

Index

Constructors

Properties

_name _peers client raw

Accessors

data dataStr id profileWallet type user widgetId

Methods

answer editWidgetData

Constructors

constructor

new SharedWidgetQueryContext(
client: TelegramClient,
query: SharedWidgetQuery,
): SharedWidgetQueryContext
Parameters
- client: TelegramClient
- query: SharedWidgetQuery
Returns SharedWidgetQueryContext
Overrides SharedWidgetQuery.constructor
- Defined in packages/dispatcher/src/context/widget-query.ts:86

Properties

`Readonly`_name

_name: "shared_widget_query" = ...

`Readonly`_peers

_peers: PeersIndex

`Readonly`client

client: TelegramClient

`Readonly`raw

raw: RawUpdateBotWidgetCopyQuery

Accessors

data

get data(): Uint8Array
Data sent by the widget

Note that this field is defined by the widget running on the client, and a bad client can send arbitrary data in this field.

Returns Uint8Array
Implementation of UpdateContext.data
Inherited from SharedWidgetQuery.data
- Defined in packages/core/src/highlevel/types/updates/widget-query.ts:87

dataStr

get dataStr(): string
data parsed as a UTF8 string

Returns string
Implementation of UpdateContext.dataStr
Inherited from SharedWidgetQuery.dataStr
- Defined in packages/core/src/highlevel/types/updates/widget-query.ts:92

id

get id(): Long
ID of this query, to be used in TelegramClient.answerWidgetQuery

Returns Long
Implementation of UpdateContext.id
Inherited from SharedWidgetQuery.id
- Defined in packages/core/src/highlevel/types/updates/widget-query.ts:67

profileWallet

get profileWallet(): RawCard | null
Wallet from the user's profile, only available when the widget explicitly asked for it (see WidgetQueryType)

Returns RawCard | null
Implementation of UpdateContext.profileWallet
Inherited from SharedWidgetQuery.profileWallet
- Defined in packages/core/src/highlevel/types/updates/widget-query.ts:100

type

get type(): WidgetQueryType
Type of the query

Returns WidgetQueryType
Implementation of UpdateContext.type
Inherited from SharedWidgetQuery.type
- Defined in packages/core/src/highlevel/types/updates/widget-query.ts:77

user

get user(): User
User who has sent the query

Returns User
Implementation of UpdateContext.user
Inherited from SharedWidgetQuery.user
- Defined in packages/core/src/highlevel/types/updates/widget-query.ts:72

widgetId

get widgetId(): Long
ID of the shared widget

Returns Long
Implementation of UpdateContext.widgetId
Inherited from SharedWidgetQuery.widgetId
- Defined in packages/core/src/highlevel/types/updates/widget-query.ts:210

Methods

answer

answer(result?: string): Promise<void>
Answer to this widget query
Parameters
- Optionalresult: string
Returns Promise<void>
- Defined in packages/dispatcher/src/context/widget-query.ts:94

editWidgetData

editWidgetData(
    params: Omit<
        Parameters<TelegramClient["editSharedWidgetData"]>[0],
        "widgetId",
    >,
): Promise<void>
Edit shared state of the widget
Parameters
- params: Omit<Parameters<TelegramClient["editSharedWidgetData"]>[0], "widgetId">
Returns Promise<void>
- Defined in packages/dispatcher/src/context/widget-query.ts:99