Type alias RenderInMailOptions

RenderInMailOptions: { position: "modal" | "activeEditorFooter"; id?: string; schema?: { body: Record<string, any>[]; [key: string]: any } }

Type declaration

  • position: "modal" | "activeEditorFooter"

    ui position

  • Optional id?: string

    The id of previously rendered ui, only needed when updating or deleting the ui

  • Optional schema?: { body: Record<string, any>[]; [key: string]: any }

    We use AdaptiveCards v3 to render custom ui, the schema is AdaptiveCards Schema, and the schema version we support is 1.6. Such as

    {
      "body": [...]
      "actions": [...]
      ...
    }

    Don't support templating in this case, and support all adaptive card elements up to version 1.6.

    If schema is empty or not exist, means delete the ui specified by id, otherwise means updating the ui specified by id or creating new ui when id is not specified.

    We also customized some elements, as follows:

    Link - The link element generated by the a tag, since desktop client v6.4.5.

    property type required description
    type 'Link' yes must be 'Link'
    mode 'button' | 'text' no display mode, default is 'text'
    url string yes link url
    text string no link text, default is link url
    • [key: string]: any
    • body: Record<string, any>[]

Settings

Member Visibility

Theme

Generated using TypeDoc