HighlightMetadataBlock

  • attributes
    Type: object
    required
    • pageTitle
      Type: string | null
      required
    • pageUrl
      Type: string | nullFormat: uri
      required
  • caption
    Type: string | null
    required

    Summary text

  • extensionContext
    Type: object | null
    required
    • noteType
      enum
      const:  
      text
      required
      values
      • text
    • pageTitle
      Type: string
      required
    • pageUrl
      Type: stringFormat: uri
      required
    • text
      Type: string
      required
    • textRange
      Type: object
      required
  • webpage
    required
    • favicon
      Type: object · PresignedImage nullable
      required
    • html
      Type: object · PresignedFile nullable
      required
    • image
      Type: object · PresignedImage nullable
      required
    • reader
      Type: object · PresignedFile nullable
      required
    • screenshot
      Type: object · PresignedImage nullable
      required
    • description
      Type: string | null

      Description of the link preview

    • metadata

      Metadata for special links

      • propertyName
        Type: anything nullable
    • siteName
      Type: string | null

      Site name of the link preview

    • status
      Type: string | null · ProcessingStateenum

      Status of the link preview

      values
      • pending
      • processing
      • completed
      • failed
    • title
      Type: string | null

      Title of the link preview

    • url
      Type: string | null

      URL of the link preview

  • keywords
    Type: array string[] | null

    Keywords

  • pdfRender
    Type: object | null
    • storagePath
      Type: string
      required

      Storage path of the PDF file