teleproto - v1.229.0
    Preparing search index...

    Interface ForwardMessagesParams

    interface used for forwarding messages

    interface ForwardMessagesParams {
        allowPaidFloodskip?: boolean;
        allowPaidStars?: BigInteger;
        background?: boolean;
        dropAuthor?: boolean;
        dropMediaCaptions?: boolean;
        effect?: BigInteger;
        fromPeer: EntityLike;
        messages: MessageIDLike | MessageIDLike[];
        noforwards?: boolean;
        quickReplyShortcut?: string | number | TypeInputQuickReplyShortcut;
        replyTo?: number | Message | TypeInputReplyTo;
        schedule?: number;
        scheduleRepeatPeriod?: number;
        sendAs?: EntityLike;
        silent?: boolean;
        suggestedPost?: SuggestedPost;
        topMsgId?: number | Message;
        videoTimestamp?: number;
        withMyScore?: boolean;
    }
    Index
    allowPaidFloodskip? allowPaidStars? background? dropAuthor? dropMediaCaptions? effect? fromPeer messages noforwards? quickReplyShortcut? replyTo? schedule? scheduleRepeatPeriod? sendAs? silent? suggestedPost? topMsgId? videoTimestamp? withMyScore?
    allowPaidFloodskip?: boolean

    Bots only: if set, allows sending up to 1000 messages per second past the flood limits, at a Stars cost.

    allowPaidStars?: BigInteger

    Stars to pay for sending a paid message, when the recipient charges for messages.

    background?: boolean

    Send the forward as a background message.

    dropAuthor?: boolean
    dropMediaCaptions?: boolean

    If true, drop media captions when forwarding.

    effect?: BigInteger

    Message effect ID (animation/visual effect).

    fromPeer: EntityLike

    If the given messages are integer IDs and not instances of the Message class, this must be specified in order for the forward to work.

    messages: MessageIDLike | MessageIDLike[]

    The message(s) to forward, or their integer IDs.

    noforwards?: boolean
    quickReplyShortcut?: string | number | TypeInputQuickReplyShortcut

    Add the forward to a quick-reply shortcut instead of sending it. A shortcut name, shortcut ID, or a raw Api.TypeInputQuickReplyShortcut.

    replyTo?: number | Message | TypeInputReplyTo

    Send the forwarded messages as a reply to this message. Accepts a message ID, a Message, or a raw Api.TypeInputReplyTo.

    schedule?: number

    If set, the message(s) won't forward immediately, and instead they will be scheduled to be automatically sent at a later time.

    scheduleRepeatPeriod?: number

    Repeat period (in seconds) for recurring scheduled messages. Requires schedule.

    sendAs?: EntityLike

    Send the forwarded message as a specific entity (channel/user).

    silent?: boolean

    Whether the message should notify people with sound or not.
    Defaults to false (send with a notification sound unless the person has the chat muted). Set it to true to alter this behaviour.

    suggestedPost?: SuggestedPost

    Suggested-post metadata for direct-messages channels.

    topMsgId?: number | Message

    Used for threads to reply to a specific thread

    videoTimestamp?: number

    Start playback timestamp (in seconds) for the forwarded video.

    withMyScore?: boolean

    If true, forward the game score along with the message.

    Settings
    Member Visibility

    On This Page
    Properties