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

    Interface SendMessageInput

    Properties required to send a new message.

    SendMessageInput

    interface SendMessageInput {
        clientMessageDuration?: number;
        handleId: HandleId;
        mentions: MessageMention[];
        message: string;
        recipient: Recipient;
        replyToMessageId?: string;
        serverMessageDuration?: number;
        threadId?: string;
    }
    Index

    Properties

    clientMessageDuration? handleId mentions message recipient replyToMessageId? serverMessageDuration? threadId?

    Properties

    clientMessageDuration?: number

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

    handleId: HandleId

    Identifier of the handle owned by this client.

    mentions: MessageMention[]

    A list of mentions included in the message. Use this to notify specific handles ({ type: 'Handle', handleId, name }) or all participants in a chat ({ type: 'Chat' }).

    message: string

    The message text to send.

    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.

    Settings

    Member Visibility

    On This Page

    Properties