Interface EditInfo

Source
Expand description

Display metadata for an edit, shown in the chat.

interface EditInfo {
    document?: string;
    startinfo?: string;
    summary?: string;
}

Properties§

§document?: string

document name as set by the sender. Implementations show the document name e.g. beside the app icon or in the title bar.

§startinfo?: string

Short, informational message that will be added to the chat, eg. "Alice voted" or "Bob scored 123 in MyGame"; usually only one line of text is shown, use this option sparingly to not spam the chat.

§summary?: string

Short text, shown besides the app icon. Recommended to use for some aggregated value, e.g. "8 votes", "Highscore: 123". Do not add linebreaks. Implementations will truncate the text at about 20 characters or less.