Class MessageContext<S>

Type Parameters

S = ContextDefaultState

Hierarchy (View Summary)

Context<IMessageContextPayload, S, MessageContextType, MessageContextSubType>
Attachmentable
IAllAttachmentable
- MessageContext

Indexable

[key: string]: any

Index

Constructors

constructor

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

Properties

`Protected`[kAttachments]

"[kAttachments]": (
Attachment<object, string>
| ExternalAttachment<object, string>
)[]

`Protected`[kForwards]

"[kForwards]": MessageForwardsCollection<S>

`Protected`[kMessagePayload]

"[kMessagePayload]": any

`Protected`[kReplyMessage]

"[kReplyMessage]": undefined | MessageContext<S>

`Protected`$filled

$filled: boolean

`Optional`$groupId

$groupId?: number

$match

$match: RegExpMatchArray

`Protected`api

api: API

getAllAttachments

getAllAttachments: {
    (type: "audio" | AUDIO): AudioAttachment[];
    (type: "audio_message" | AUDIO_MESSAGE): AudioMessageAttachment[];
    (type: "graffiti" | GRAFFITI): GraffitiAttachment[];
    (type: "doc" | DOCUMENT): DocumentAttachment[];
    (type: "market_album" | MARKET_ALBUM): MarketAlbumAttachment[];
    (type: "market" | MARKET): MarketAttachment[];
    (type: "photo" | PHOTO): PhotoAttachment[];
    (type: "story" | STORY): StoryAttachment[];
    (type: "video" | VIDEO): VideoAttachment[];
    (type: "wall" | WALL): WallAttachment[];
    (type: "poll" | POLL): PollAttachment[];
    (type: "gift" | GIFT): GiftAttachment[];
    (type: "link" | LINK): LinkAttachment[];
    (type: "sticker" | STICKER): StickerAttachment[];
    (type: "wall_reply" | WALL_REPLY): WallReplyAttachment[];
}

Type Declaration

- (type: "audio" | AUDIO): AudioAttachment[]
- Returns the attachments
  Parameters
  - type: "audio" | AUDIO
  Returns AudioAttachment[]
- (type: "audio_message" | AUDIO_MESSAGE): AudioMessageAttachment[]
- Returns the attachments
  Parameters
  - type: "audio_message" | AUDIO_MESSAGE
  Returns AudioMessageAttachment[]
- (type: "graffiti" | GRAFFITI): GraffitiAttachment[]
- Returns the attachments
  Parameters
  - type: "graffiti" | GRAFFITI
  Returns GraffitiAttachment[]
- (type: "doc" | DOCUMENT): DocumentAttachment[]
- Returns the attachments
  Parameters
  - type: "doc" | DOCUMENT
  Returns DocumentAttachment[]
- (type: "market_album" | MARKET_ALBUM): MarketAlbumAttachment[]
- Returns the attachments
  Parameters
  - type: "market_album" | MARKET_ALBUM
  Returns MarketAlbumAttachment[]
- (type: "market" | MARKET): MarketAttachment[]
- Returns the attachments
  Parameters
  - type: "market" | MARKET
  Returns MarketAttachment[]
- (type: "photo" | PHOTO): PhotoAttachment[]
- Returns the attachments
  Parameters
  - type: "photo" | PHOTO
  Returns PhotoAttachment[]
- (type: "story" | STORY): StoryAttachment[]
- Returns the attachments
  Parameters
  - type: "story" | STORY
  Returns StoryAttachment[]
- (type: "video" | VIDEO): VideoAttachment[]
- Returns the attachments
  Parameters
  - type: "video" | VIDEO
  Returns VideoAttachment[]
- (type: "wall" | WALL): WallAttachment[]
- Returns the attachments
  Parameters
  - type: "wall" | WALL
  Returns WallAttachment[]
- (type: "poll" | POLL): PollAttachment[]
- Returns the attachments
  Parameters
  - type: "poll" | POLL
  Returns PollAttachment[]
- (type: "gift" | GIFT): GiftAttachment[]
- Returns the attachments
  Parameters
  - type: "gift" | GIFT
  Returns GiftAttachment[]
- (type: "link" | LINK): LinkAttachment[]
- Returns the attachments
  Parameters
  - type: "link" | LINK
  Returns LinkAttachment[]
- (type: "sticker" | STICKER): StickerAttachment[]
- Returns the attachments
  Parameters
  - type: "sticker" | STICKER
  Returns StickerAttachment[]
- (type: "wall_reply" | WALL_REPLY): WallReplyAttachment[]
- Returns the attachments
  Parameters
  - type: "wall_reply" | WALL_REPLY
  Returns WallReplyAttachment[]

hasAllAttachments

hasAllAttachments: (type?: AttachmentTypeString | AttachmentType) => boolean

Type Declaration

- (type?: AttachmentTypeString | AttachmentType): boolean
- Checks for the presence of attachments
  Parameters
  - Optionaltype: AttachmentTypeString | AttachmentType
  Returns boolean

`Protected`payload

payload: IMessageContextPayload

state

state: S

subTypes

subTypes: MessageContextSubType[]

`Optional`text

text?: string

type

type: "message"

`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

adminAuthorId

get adminAuthorId(): undefined | number
Returns the sender (admin community) identifier, only for community messages

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/message.ts:403

attachments

get attachments(): (
Attachment<object, string>
| ExternalAttachment<object, string>
)[]
Returns the attachments

Returns (Attachment<object, string> | ExternalAttachment<object, string>)[]
- Defined in packages/vk-io/src/structures/contexts/message.ts:501

chatId

get chatId(): undefined | number
Returns the identifier chat

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/message.ts:353

clientInfo

get clientInfo(): {
    button_actions: (
        "location"
        | "text"
        | "vkpay"
        | "open_app"
        | "open_link"
        | "callback"
    )[];
    carousel: boolean;
    inline_keyboard: boolean;
    keyboard: boolean;
    lang_id: number;
}
Returns the capabilities of the client the user is using.

Returns {
    button_actions: (
        "location"
        | "text"
        | "vkpay"
        | "open_app"
        | "open_link"
        | "callback"
    )[];
    carousel: boolean;
    inline_keyboard: boolean;
    keyboard: boolean;
    lang_id: number;
}
- Defined in packages/vk-io/src/structures/contexts/message.ts:508

conversationMessageId

get conversationMessageId(): undefined | number
Returns the conversation message id

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/message.ts:318

createdAt

get createdAt(): number
Returns the date when this message was created

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

eventEmail

get eventEmail(): undefined | string
Returns the event email

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

eventMemberId

get eventMemberId(): undefined | number
Returns the event member id

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/message.ts:459

eventText

get eventText(): undefined | string
Returns the event name

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

eventType

get eventType(): undefined | MessageContextPayloadEventType
Returns the event name

Returns undefined | MessageContextPayloadEventType
- Defined in packages/vk-io/src/structures/contexts/message.ts:452

forwards

get forwards(): MessageForwardsCollection<S>
Returns the forwards

Returns MessageForwardsCollection<S>
- Defined in packages/vk-io/src/structures/contexts/message.ts:487

geo

get geo(): | undefined
| {
    coordinates: { latitude: number; longitude: number };
    place?: {
        address?: number;
        checkins?: number;
        city: string;
        country: number;
        created?: number;
        group_id?: number;
        group_photo?: string;
        icon?: string;
        id: number;
        latitude?: number;
        longitude?: number;
        title?: string;
        type?: number;
        updated?: number;
    };
    type: "point";
}
Returns geo

Returns
    | undefined
    | {
        coordinates: { latitude: number; longitude: number };
        place?: {
            address?: number;
            checkins?: number;
            city: string;
            country: number;
            created?: number;
            group_id?: number;
            group_photo?: string;
            icon?: string;
            id: number;
            latitude?: number;
            longitude?: number;
            title?: string;
            type?: number;
            updated?: number;
        };
        type: "point";
    }
- Defined in packages/vk-io/src/structures/contexts/message.ts:392

hasForwards

get hasForwards(): boolean
Checks for forwarded messages

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

hasGeo

get hasGeo(): boolean
Checks if there is text

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

hasMessagePayload

get hasMessagePayload(): boolean
Checks for hast message payload

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

hasReplyMessage

get hasReplyMessage(): boolean
Checks for reply message

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

hasText

get hasText(): boolean
Checks if there is text

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

id

get id(): number
Returns the identifier message

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

isChat

get isChat(): boolean
Checks is a chat

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

isCropped

get isCropped(): undefined | boolean
Checks whether the message is cropped for bot

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/contexts/message.ts:410

isDM

get isDM(): boolean
Checks a message has arrived in direct messages

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

isEvent

get isEvent(): boolean
Check is special event

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

isExpired

get isExpired(): undefined | boolean
Checks whether the message is expired

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/contexts/message.ts:445

isFromGroup

get isFromGroup(): boolean
Checks is from the group

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

isFromUser

get isFromUser(): boolean
Checks is from the user

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

isGroup

get isGroup(): boolean
Checks is a group

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

isImportant

get isImportant(): boolean
Checks that the message is important

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

isInbox

get isInbox(): boolean
Checks whether the message is inboxed

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

isOutbox

get isOutbox(): boolean
Checks whether the message is outbox

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

isUser

get isUser(): boolean
Check is a user

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

membersCount

get membersCount(): undefined | number
Returns the members count

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/message.ts:417

`Protected`message

get message(): {
    action?: {
        email?: string;
        member_id?: number;
        photo?: { photo_100: string; photo_200: string; photo_50: string };
        text?: string;
        type: MessageContextPayloadEventType;
    };
    admin_author_id?: number;
    attachments: object[];
    conversation_message_id: number;
    date: number;
    from_id: number;
    fwd_messages?: (
        { id: number; conversation_message_id: number; out: number; peer_id: number; from_id: number; text?: string | undefined; date: number; update_time?: number | undefined; random_id: number; ref?: string | undefined; ... 14 more ...; is_expired?: boolean | undefined; }
    )[];
    geo?: {
        coordinates: { latitude: number; longitude: number };
        place?: {
            address?: number;
            checkins?: number;
            city: string;
            country: number;
            created?: number;
            group_id?: number;
            group_photo?: string;
            icon?: string;
            id: number;
            latitude?: number;
            longitude?: number;
            title?: string;
            type?: number;
            updated?: number;
        };
        type: "point";
    };
    id: number;
    important: boolean;
    is_cropped?: boolean;
    is_expired?: boolean;
    members_count?: number;
    message_tag?: string;
    out: number;
    payload?: string;
    peer_id: number;
    pinned_at?: number;
    random_id: number;
    ref?: string;
    ref_source?: string;
    reply_message?: { id: number; conversation_message_id: number; out: number; peer_id: number; from_id: number; text?: string | undefined; date: number; update_time?: number | undefined; random_id: number; ref?: string | undefined; ... 14 more ...; is_expired?: boolean | undefined; };
    text?: string;
    update_time?: number;
    was_listened?: boolean;
}
Return alias of payload.message

Returns {
    action?: {
        email?: string;
        member_id?: number;
        photo?: { photo_100: string; photo_200: string; photo_50: string };
        text?: string;
        type: MessageContextPayloadEventType;
    };
    admin_author_id?: number;
    attachments: object[];
    conversation_message_id: number;
    date: number;
    from_id: number;
    fwd_messages?: (
        { id: number; conversation_message_id: number; out: number; peer_id: number; from_id: number; text?: string | undefined; date: number; update_time?: number | undefined; random_id: number; ref?: string | undefined; ... 14 more ...; is_expired?: boolean | undefined; }
    )[];
    geo?: {
        coordinates: { latitude: number; longitude: number };
        place?: {
            address?: number;
            checkins?: number;
            city: string;
            country: number;
            created?: number;
            group_id?: number;
            group_photo?: string;
            icon?: string;
            id: number;
            latitude?: number;
            longitude?: number;
            title?: string;
            type?: number;
            updated?: number;
        };
        type: "point";
    };
    id: number;
    important: boolean;
    is_cropped?: boolean;
    is_expired?: boolean;
    members_count?: number;
    message_tag?: string;
    out: number;
    payload?: string;
    peer_id: number;
    pinned_at?: number;
    random_id: number;
    ref?: string;
    ref_source?: string;
    reply_message?: { id: number; conversation_message_id: number; out: number; peer_id: number; from_id: number; text?: string | undefined; date: number; update_time?: number | undefined; random_id: number; ref?: string | undefined; ... 14 more ...; is_expired?: boolean | undefined; };
    text?: string;
    update_time?: number;
    was_listened?: boolean;
}
- Defined in packages/vk-io/src/structures/contexts/message.ts:756

messagePayload

get messagePayload(): any
Returns the message payload

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

messageTag

get messageTag(): undefined | string
Returns the string for matching user Notify and VK

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

peerId

get peerId(): number
Returns the destination identifier

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

peerType

get peerType(): string
Returns the peer type

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

pinnedAt

get pinnedAt(): undefined | number
Returns the date when this message was pinned

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/message.ts:431

referralSource

get referralSource(): undefined | string
Returns the referral source

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

referralValue

get referralValue(): undefined | string
Returns the referral value

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

replyMessage

get replyMessage(): undefined | MessageContext<S>
Returns the reply message

Returns undefined | MessageContext<S>
- Defined in packages/vk-io/src/structures/contexts/message.ts:494

senderId

get senderId(): number
Returns the sender identifier

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

senderType

get senderType(): string
Returns the sender type

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

updatedAt

get updatedAt(): undefined | number
Returns the date when this message was updated

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/message.ts:385

wasListened

get wasListened(): undefined | boolean
Checks whether the attached audio message has already been listened by you

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/contexts/message.ts:424

Methods

[kSerializeData]

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

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

deleteMessage

deleteMessage(options?: Partial<MessagesDeleteParams>): Promise<boolean>
Deletes the message
Parameters
- options: Partial<MessagesDeleteParams> = {}
Returns Promise<boolean>
- Defined in packages/vk-io/src/structures/contexts/message.ts:726

editMessage

editMessage(params: IMessageContextSendOptions): Promise<number>
Edits a message
Parameters
- params: IMessageContextSendOptions
Returns Promise<number>
- Defined in packages/vk-io/src/structures/contexts/message.ts:515

getAttachments

getAttachments(type: "audio" | AUDIO): AudioAttachment[]
Returns the attachments
Parameters
- type: "audio" | AUDIO
Returns AudioAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:41
getAttachments(type: "audio_message" | AUDIO_MESSAGE): AudioMessageAttachment[]
Returns the attachments
Parameters
- type: "audio_message" | AUDIO_MESSAGE
Returns AudioMessageAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:43
getAttachments(type: "graffiti" | GRAFFITI): GraffitiAttachment[]
Returns the attachments
Parameters
- type: "graffiti" | GRAFFITI
Returns GraffitiAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:45
getAttachments(type: "doc" | DOCUMENT): DocumentAttachment[]
Returns the attachments
Parameters
- type: "doc" | DOCUMENT
Returns DocumentAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:47
getAttachments(type: "market_album" | MARKET_ALBUM): MarketAlbumAttachment[]
Returns the attachments
Parameters
- type: "market_album" | MARKET_ALBUM
Returns MarketAlbumAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:49
getAttachments(type: "market" | MARKET): MarketAttachment[]
Returns the attachments
Parameters
- type: "market" | MARKET
Returns MarketAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:51
getAttachments(type: "photo" | PHOTO): PhotoAttachment[]
Returns the attachments
Parameters
- type: "photo" | PHOTO
Returns PhotoAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:53
getAttachments(type: "story" | STORY): StoryAttachment[]
Returns the attachments
Parameters
- type: "story" | STORY
Returns StoryAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:55
getAttachments(type: "video" | VIDEO): VideoAttachment[]
Returns the attachments
Parameters
- type: "video" | VIDEO
Returns VideoAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:57
getAttachments(type: "wall" | WALL): WallAttachment[]
Returns the attachments
Parameters
- type: "wall" | WALL
Returns WallAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:59
getAttachments(type: "poll" | POLL): PollAttachment[]
Returns the attachments
Parameters
- type: "poll" | POLL
Returns PollAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:61
getAttachments(type: "gift" | GIFT): GiftAttachment[]
Returns the attachments
Parameters
- type: "gift" | GIFT
Returns GiftAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:63
getAttachments(type: "link" | LINK): LinkAttachment[]
Returns the attachments
Parameters
- type: "link" | LINK
Returns LinkAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:65
getAttachments(type: "sticker" | STICKER): StickerAttachment[]
Returns the attachments
Parameters
- type: "sticker" | STICKER
Returns StickerAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:67
getAttachments(type: "wall_reply" | WALL_REPLY): WallReplyAttachment[]
Returns the attachments
Parameters
- type: "wall_reply" | WALL_REPLY
Returns WallReplyAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:69

hasAttachments

hasAttachments(type?: AttachmentTypeString | AttachmentType): boolean
Checks for the presence of attachments
Parameters
- Optionaltype: AttachmentTypeString | AttachmentType
Returns boolean
Inherited from Attachmentable.hasAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:30

is

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

loadMessagePayload

loadMessagePayload(__namedParameters?: { force?: boolean }): Promise<void>
Load message payload
Parameters
- __namedParameters: { force?: boolean } = {}
Returns Promise<void>
- Defined in packages/vk-io/src/structures/contexts/message.ts:178

reply

reply(
text: string | IMessageContextSendOptions,
params?: IMessageContextSendOptions,
): Promise<MessageContext<S>>
Responds to the current message
Parameters
- text: string | IMessageContextSendOptions
- Optionalparams: IMessageContextSendOptions
Returns Promise<MessageContext<S>>
- Defined in packages/vk-io/src/structures/contexts/message.ts:616

restoreMessage

restoreMessage(): Promise<boolean>
Restores the message

Returns Promise<boolean>
- Defined in packages/vk-io/src/structures/contexts/message.ts:745

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.ts:536

sendAudioMessage

sendAudioMessage(
source: IUploadSourceMedia,
params?: IMessageContextSendOptions,
): Promise<MessageContext<S>>
Sends an audio message to the current dialog
Parameters
- source: IUploadSourceMedia
- params: IMessageContextSendOptions = {}
Returns Promise<MessageContext<S>>
- Defined in packages/vk-io/src/structures/contexts/message.ts:694

sendDocuments

sendDocuments(
rawSources: AllowArray<IUploadSourceMedia>,
params?: IMessageContextSendOptions,
): Promise<MessageContext<S>>
Sends a documents to the current dialog
Parameters
- rawSources: AllowArray<IUploadSourceMedia>
- params: IMessageContextSendOptions = {}
Returns Promise<MessageContext<S>>
- Defined in packages/vk-io/src/structures/contexts/message.ts:668

sendPhotos

sendPhotos(
rawSources: AllowArray<IUploadSourceMedia>,
params?: IMessageContextSendOptions,
): Promise<MessageContext<S>>
Sends a photos to the current dialog
Parameters
- rawSources: AllowArray<IUploadSourceMedia>
- params: IMessageContextSendOptions = {}
Returns Promise<MessageContext<S>>
- Defined in packages/vk-io/src/structures/contexts/message.ts:642

setActivity

setActivity(): Promise<boolean>
Changes the status of typing in the dialog

Returns Promise<boolean>
- Defined in packages/vk-io/src/structures/contexts/message.ts:714

toJSON

toJSON(): object
Returns data for JSON

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

Class MessageContext<S>

Type Parameters

Hierarchy (View Summary)

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MessageContext<S>

Properties

Protected[kAttachments]

Protected[kForwards]

Protected[kMessagePayload]

Protected[kReplyMessage]

Protected$filled

Optional$groupId

$match

Protectedapi

getAllAttachments

Type Declaration

Parameters

Returns AudioAttachment[]

Parameters

Returns AudioMessageAttachment[]

Parameters

Returns GraffitiAttachment[]

Parameters

Returns DocumentAttachment[]

Parameters

Returns MarketAlbumAttachment[]

Parameters

Returns MarketAttachment[]

Parameters

Returns PhotoAttachment[]

Parameters

Returns StoryAttachment[]

Parameters

Returns VideoAttachment[]

Parameters

Returns WallAttachment[]

Parameters

Returns PollAttachment[]

Parameters

Returns GiftAttachment[]

Parameters

Returns LinkAttachment[]

Parameters

Returns StickerAttachment[]

Parameters

Returns WallReplyAttachment[]

hasAllAttachments

Type Declaration

Parameters

Returns boolean

Protectedpayload

state

subTypes

Optionaltext

type

Protectedupload

Accessors

[toStringTag]

Returns string

adminAuthorId

Returns undefined | number

attachments

Returns (Attachment<object, string> | ExternalAttachment<object, string>)[]

chatId

Returns undefined | number

clientInfo

Returns { button_actions: ( "location" | "text" | "vkpay" | "open_app" | "open_link" | "callback" )[]; carousel: boolean; inline_keyboard: boolean; keyboard: boolean; lang_id: number;}

conversationMessageId

Returns undefined | number

createdAt

Returns number

`Protected`[kAttachments]

`Protected`[kForwards]

`Protected`[kMessagePayload]

`Protected`[kReplyMessage]

`Protected`$filled

`Optional`$groupId

`Protected`api

`Protected`payload

`Optional`text

`Protected`upload

Returns {
button_actions: (
"location"
| "text"
| "vkpay"
| "open_app"
| "open_link"
| "callback"
)[];
carousel: boolean;
inline_keyboard: boolean;
keyboard: boolean;
lang_id: number;
}

`Protected`message