Namespace content

registerLinkPreviewProvider

• registerLinkPreviewProvider(urlMatchPattern: string, provider: LinkPreviewProvider): Unsubscribable

• EXPERIMENTAL. This API is subject to change without notice and has no compatibility guarantees.

  Registers a provider for link previews (LinkPreviewProvider) for all URLs in a document matching the {@link urlMatchPattern}. A link preview is a description of the information available at a URL.

  todo

  Support a more powerful syntax for URL match patterns, such as Chrome's (https://developer.chrome.com/extensions/match_patterns).

  Parameters

  • urlMatchPattern: string

    A pattern that matches URLs for which the provider is called to obtain a preview. Currently it matches all URLs that start with the match pattern (i.e., string prefix matches). No wildcards are supported.

  • provider: LinkPreviewProvider

    The link preview provider.

  Returns Unsubscribable