Interface ForwardMessageOptions

interface ForwardMessageOptions {
    clearDraft?: boolean;
    forbidForwards?: boolean;
    noAuthor?: boolean;
    noCaption?: boolean;
    quickReply?: string | number;
    schedule?: number | Date;
    sendAs?: InputPeerLike;
    shouldDispatch?: true;
    silent?: boolean;
    toChatId: InputPeerLike;
}

Properties

clearDraft? forbidForwards? noAuthor? noCaption? quickReply? schedule? sendAs? shouldDispatch? silent? toChatId

Properties

OptionalclearDraft

clearDraft?: boolean

Whether to clear draft after sending this message (only used for caption)

Default

false

OptionalforbidForwards

forbidForwards?: boolean

Whether to disallow further forwards of this message.

Only for bots, works even if the target chat does not have content protection.

OptionalnoAuthor

noAuthor?: boolean

Whether to forward without author

OptionalnoCaption

noCaption?: boolean

Whether to forward without caption (implies noAuthor)

OptionalquickReply

quickReply?: string | number

If passed, instead of sending the message, it will be saved into the given quick reply shortcut (either its ID or its shortcut string).

Optionalschedule

schedule?: number | Date

If set, the forwarding will be scheduled to this date (also applies to caption message). When passing a number, a UNIX time in ms is expected.

You can also pass 0x7FFFFFFE, this will send the message once the peer is online

OptionalsendAs

sendAs?: InputPeerLike

Peer to use when sending the message.

OptionalshouldDispatch

shouldDispatch?: true

Whether to dispatch the forwarded messages to the client's update handler.

Optionalsilent

silent?: boolean

Whether to forward silently (also applies to caption message).

toChatId

toChatId: InputPeerLike

Destination chat ID, username, phone, "me" or "self"

Settings

Member Visibility

On This Page

Properties