Class MessagesReadContext<S>

Type Parameters

S = ContextDefaultState

Hierarchy (view full)

Context<IMessagesReadContextPayload, S, MessagesReadContextType, MessagesReadContextSubType>
- MessagesReadContext

Index

Constructors

Properties

$groupId? api payload state subTypes type upload

Accessors

[toStringTag] isInbox isOutbox localId peerId

Methods

[kSerializeData] is toJSON

Constructors

constructor

new MessagesReadContext<S>(options): MessagesReadContext<S>
Type Parameters
- S = ContextDefaultState
Parameters
- options: MessagesReadContextContextOptions<S>
Returns MessagesReadContext<S>
Overrides Context.constructor
- Defined in packages/vk-io/src/structures/contexts/messages-read.ts:32

Properties

`Optional` $groupId

$groupId?: number

`Protected` api

api: API

`Protected` payload

payload: IMessagesReadContextPayload

state

state: S

subTypes

subTypes: MessagesReadContextSubType[]

type

type: "messages_read"

`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

isInbox

get isInbox(): boolean
Checks that inbox messages are read

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/messages-read.ts:53

isOutbox

get isOutbox(): boolean
Checks that outbox messages are read

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/messages-read.ts:60

localId

get localId(): number
Returns the identifier of the local message

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

peerId

get peerId(): number
Returns the peer ID

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

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

Returns object
Overrides Context.[kSerializeData]
- Defined in packages/vk-io/src/structures/contexts/messages-read.ts:81

is

is(rawTypes): boolean
Checks whether the context of some of these types
Parameters
- rawTypes: ("messages_read" | MessagesReadContextSubType)[]
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