Interface EditMediaCaptionInput

Properties required to edit an existing caption for a media attachment.

EditMediaCaptionInput

interface EditMediaCaptionInput {
    caption: string;
    handleId: HandleId;
    mentions: MessageMention[];
    messageId: string;
    recipient: Recipient;
}

Index

Properties

caption handleId mentions messageId recipient

Properties

caption

caption: string

The new caption text that will replace the older caption.

handleId

handleId: HandleId

Identifier of the handle owned by this client.

mentions

mentions: MessageMention[]

(Optional) The list of mentions in the caption.

messageId

messageId: string

The identifier of the message to edit.

recipient

recipient: Recipient

The target recipient.