Type alias RenderInMailActiveEditorOptions

RenderInMailActiveEditorOptions: { position: "footer"; id?: string; schema?: { type?: "AdaptiveCard"; version?: string; body: Record<string, any>[]; [key: string]: any } }

Type declaration

  • position: "footer"

    ui location, currently only supports footer

  • Optional id?: string

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

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

    We use AdaptiveCards v3 to render custom ui, the schema is AdaptiveCards Schema. Such as

    {
      "type": "AdaptiveCard",
      "version": "xxx",
      "body": [...]
    }

    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.

    • [key: string]: any
    • Optional type?: "AdaptiveCard"

      default is AdaptiveCard

    • Optional version?: string

      range is ['1.0', '1.6'], default is '1.6'

    • body: Record<string, any>[]

Settings

Member Visibility

Theme

Generated using TypeDoc