@sudoplatform/sudo-secure-communications
    Preparing search index...

    Interface SendMediaInput

    Properties required to send a new media message.

    SendMediaInput

    interface SendMediaInput {
        caption?: string;
        clientMessageDuration?: number;
        file: ArrayBuffer;
        fileName: string;
        fileSize: number;
        fileType: string;
        handleId: HandleId;
        mentions?: MessageMention[];
        recipient: Recipient;
        replyToMessageId?: string;
        serverMessageDuration?: number;
        threadId?: string;
        thumbnail?: ArrayBuffer;
        thumbnailInfo?: ThumbnailInfo;
    }
    Index

    Properties

    caption? clientMessageDuration? file fileName fileSize fileType handleId mentions? recipient replyToMessageId? serverMessageDuration? threadId? thumbnail? thumbnailInfo?

    Properties

    caption?: string

    (Optional) The caption text for the media file.

    clientMessageDuration?: number

    (Optional) The locally managed duration this message should exist client side before self-destructing.

    file: ArrayBuffer

    The media file to send.

    fileName: string

    The name of the media file.

    fileSize: number

    The size of the media file in bytes.

    fileType: string

    The MIME type of the media file.

    handleId: HandleId

    Identifier of the handle owned by this client.

    mentions?: MessageMention[]

    (Optional) The list of mentions in the caption.

    recipient: Recipient

    The target recipient.

    replyToMessageId?: string

    (Optional) Required for replying to messages. The message identifier that the new message will be associated with when creating quoted message replies. This should be set to the message identifier of the message being replied to.

    serverMessageDuration?: number

    (Optional) The absolute duration this message should exist server side before self-destructing.

    threadId?: string

    (Optional) Required for thread messages. The message identifier that the new message will be associated with when creating or replying in a message thread. This should be set to the message identifier of the original message of a thread.

    thumbnail?: ArrayBuffer

    (Optional) The file containing the thumbnail.

    thumbnailInfo?: ThumbnailInfo

    (Optional) The thumbnail image information.

    Settings

    Member Visibility

    On This Page

    Properties