Interface EditorEmbedProvider


public interface EditorEmbedProvider
Provides an interface for supporting embed providers for editors. Implementations of this class must be OSGi components that are registered in the OSGi Registry.

The embed providers can optionally be categorized by using the type OSGi property with any of the values defined in EditorEmbedProviderTypeConstants. By default, the provider is categorized as EditorEmbedProviderTypeConstants.UNKNOWN, unless specified otherwise.

  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the embed provider's ID.
    Returns the template that is used by the editor to embed the content.
    Returns an array with the URL schemes for the embed provider.
  • Method Details

    • getId

      String getId()
      Returns the embed provider's ID.
      Returns:
      the embed provider's ID
    • getTpl

      String getTpl()
      Returns the template that is used by the editor to embed the content. This template is usually an iFrame to the provider that displays the content.

      The template accepts the embedId that represents the ID of the content to embed. This value is obtained from URL scheme regular expressions.

      Returns:
      the template that is used by the editor to embed the content
    • getURLSchemes

      String[] getURLSchemes()
      Returns an array with the URL schemes for the embed provider. The URL scheme describes which URLs of the provider have an embedded representation. URL schemes are defined using a JavaScript regular expression that indicates whether a URL matches the provider.

      Every URL scheme should contain a single matching group. This match is used to replace the embedId placeholder from the provided template.

      Returns:
      the URL schemes for the embed provider