BookmarkMetadataBlock

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

    Summary text

  • dominantColors
    Type: array object[]
    required

    Dominant colors of the image

    • rgb
      Type: array number[]
      required

      RGB color

    • score
      Type: number
      required

      Score

  • extensionContext
    Type: object | null
    required
    • noteType
      enum
      const:  
      page
      required
      values
      • page
  • transcript
    Type: object | null
    required

    Speech transcript of the resource

    • key
      Type: string
      required

      Storage key of the file

    • mime
      Type: string

      MIME type of the file

  • 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