Class MessageSubscriptionContext<S>

Type Parameters

S = ContextDefaultState

Hierarchy (view full)

Context<IMessageSubscriptionContextPayload, S, MessageSubscriptionContextType, MessageSubscriptionContextSubType>
- MessageSubscriptionContext

Index

Constructors

Properties

$groupId? api payload state subTypes type upload

Accessors

[toStringTag] isSubscribed isUnsubscribed key userId

Methods

[kSerializeData] is toJSON

Constructors

constructor

new MessageSubscriptionContext<S>(options): MessageSubscriptionContext<S>
Type Parameters
- S = ContextDefaultState
Parameters
- options: MessageSubscriptionContextOptions<S>
Returns MessageSubscriptionContext<S>
Overrides Context.constructor
- Defined in packages/vk-io/src/structures/contexts/message-subscription.ts:27

Properties

`Optional` $groupId

$groupId?: number

`Protected` api

api: API

`Protected` payload

payload: IMessageSubscriptionContextPayload

state

state: S

subTypes

subTypes: MessageSubscriptionContextSubType[]

type

type: "message_subscription"

`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:76

isSubscribed

get isSubscribed(): boolean
Checks that the user has subscribed to messages

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/message-subscription.ts:41

isUnsubscribed

get isUnsubscribed(): boolean
Checks that the user has unsubscribed from the messages

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/message-subscription.ts:48

key

get key(): undefined | string
Returns the key

Returns undefined | string
- Defined in packages/vk-io/src/structures/contexts/message-subscription.ts:62

userId

get userId(): number
Returns the identifier user

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

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

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

is

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

toJSON

toJSON(): object
Returns data for JSON

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

Generated using TypeDoc