Class MessageEventContext<S>

Type Parameters

S = ContextDefaultState

Hierarchy (View Summary)

Context<
    IMessageEventContextPayload,
    S,
    MessageEventContextType,
    MessageEventContextSubType,
>
- MessageEventContext

Indexable

[key: string]: any

Index

Constructors

Properties

$groupId? api payload state subTypes type upload

Accessors

[toStringTag] conversationMessageId eventId eventPayload peerId userId

Methods

[kSerializeData] answer is send toJSON

Constructors

constructor

new MessageEventContext<S = ContextDefaultState>(
options: MessageEventContextOptions<S>,
): MessageEventContext<S>
Type Parameters
- S = ContextDefaultState
Parameters
- options: MessageEventContextOptions<S>
Returns MessageEventContext<S>
Overrides Context.constructor
- Defined in packages/vk-io/src/structures/contexts/message-event.ts:48

Properties

`Optional`$groupId

$groupId?: number

`Protected`api

api: API

`Protected`payload

payload: IMessageEventContextPayload

state

state: S

subTypes

subTypes: "message_event"[]

type

type: "message_event"

`Protected`upload

upload: Upload

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns custom tag

Returns string
Inherited from Context.[toStringTag]
- Defined in packages/vk-io/src/structures/contexts/context.ts:68

conversationMessageId

get conversationMessageId(): number
Returns the conversation message id

Returns number
- Defined in packages/vk-io/src/structures/contexts/message-event.ts:67

eventId

get eventId(): string
Returns a random string. Active for a minute, after a minute becomes invalid

Returns string
- Defined in packages/vk-io/src/structures/contexts/message-event.ts:81

eventPayload

get eventPayload(): any
Returns the event payload

Returns any
- Defined in packages/vk-io/src/structures/contexts/message-event.ts:88

peerId

get peerId(): number
Returns the destination identifier

Returns number
- Defined in packages/vk-io/src/structures/contexts/message-event.ts:74

userId

get userId(): number
Returns the identifier user

Returns number
- Defined in packages/vk-io/src/structures/contexts/message-event.ts:60

Methods

[kSerializeData]

"[kSerializeData]"(): object
Returns the custom data

Returns object
Overrides Context.[kSerializeData]
- Defined in packages/vk-io/src/structures/contexts/message-event.ts:185

answer

answer(eventData: MessageEventAction): Promise<1>
Dispatches an event with an action that will occur when the callback button is pressed
Parameters
- eventData: MessageEventAction
Returns Promise<1>
- Defined in packages/vk-io/src/structures/contexts/message-event.ts:95

is

is(rawTypes: "message_event"[]): boolean
Checks whether the context of some of these types
Parameters
- rawTypes: "message_event"[]
Returns boolean
Inherited from Context.is
- Defined in packages/vk-io/src/structures/contexts/context.ts:75

send

send(
text: string | IMessageContextSendOptions,
params?: IMessageContextSendOptions,
): Promise<MessageContext<S>>
Sends a message to the current dialog
Parameters
- text: string | IMessageContextSendOptions
- Optionalparams: IMessageContextSendOptions
Returns Promise<MessageContext<S>>
- Defined in packages/vk-io/src/structures/contexts/message-event.ts:107

toJSON

toJSON(): object
Returns data for JSON

Returns object
Inherited from Context.toJSON
- Defined in packages/vk-io/src/structures/contexts/context.ts:88