Class VKAppPayloadContext<S, P>

Type Parameters

S = ContextDefaultState
P extends Record<string, any> = object

Hierarchy (View Summary)

Context<
    IVKAppPayloadPayload,
    S,
    VKAppPayloadContextType,
    VKAppPayloadContextSubType,
>
- VKAppPayloadContext

Indexable

[key: string]: any

Index

Constructors

Properties

$groupId? api payload state subTypes type upload

Accessors

[toStringTag] appId eventPayload groupId userId

Methods

[kSerializeData] is toJSON

Constructors

constructor

new VKAppPayloadContext<
    S = ContextDefaultState,
    P extends Record<string, any> = object,
>(
    options: VKAppPayloadContextOptions<S>,
): VKAppPayloadContext<S, P>
Type Parameters
- S = ContextDefaultState
- P extends Record<string, any> = object
Parameters
- options: VKAppPayloadContextOptions<S>
Returns VKAppPayloadContext<S, P>
Overrides Context.constructor
- Defined in packages/vk-io/src/structures/contexts/vk-app-payload.ts:26

Properties

`Optional`$groupId

$groupId?: number

`Protected`api

api: API

`Protected`payload

payload: IVKAppPayloadPayload

state

state: S

subTypes

subTypes: "app_payload"[]

type

type: "vk_app_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

appId

get appId(): number
Returns the identifier of the application from which the event was sent

Returns number
- Defined in packages/vk-io/src/structures/contexts/vk-app-payload.ts:45

eventPayload

get eventPayload(): P
Returns the transferred useful data

Returns P
- Defined in packages/vk-io/src/structures/contexts/vk-app-payload.ts:59

groupId

get groupId(): number
Returns the identifier of the community to which the notification was sent

Returns number
- Defined in packages/vk-io/src/structures/contexts/vk-app-payload.ts:52

userId

get userId(): number
Returns the identifier of the user whose action the event was sent to in the application

Returns number
- Defined in packages/vk-io/src/structures/contexts/vk-app-payload.ts:38

Methods

[kSerializeData]

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

Returns object
Overrides Context.[kSerializeData]
- Defined in packages/vk-io/src/structures/contexts/vk-app-payload.ts:66

is

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

toJSON

toJSON(): object
Returns data for JSON

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