Interface DLVideoExternalShortcut


public interface DLVideoExternalShortcut
Provides an external video shortcut to be used by the document library to link to and render videos hosted in external services.

Implementations of this interface will be returned by an implementation of DLVideoExternalShortcutProvider

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    Returns the description of the external video (if any).
    default String
    Returns the thumbnail URL of the external video (if any).
    default String
    Returns the title of the external video (if any).
    Returns the URL of the external video.
    renderHTML(javax.servlet.http.HttpServletRequest httpServletRequest)
    Returns a snippet of HTML that will be used to embed the video inside a specific content.
  • Method Details

    • getDescription

      default String getDescription()
      Returns the description of the external video (if any).

      It will be used to fill the document's description field when saving it to the document library.

      Returns:
      the description
    • getThumbnailURL

      default String getThumbnailURL()
      Returns the thumbnail URL of the external video (if any).

      It will be used inside the Documents and Media UI (cards, lists, etc...).

      Returns:
      the thumbnail URL.
    • getTitle

      default String getTitle()
      Returns the title of the external video (if any).

      It will be used to fill the document's title field when saving it to the document library.

      Returns:
      the title
    • getURL

      String getURL()
      Returns the URL of the external video.
      Returns:
      the URL
    • renderHTML

      String renderHTML(javax.servlet.http.HttpServletRequest httpServletRequest)
      Returns a snippet of HTML that will be used to embed the video inside a specific content.

      This will typically render an iframe or a video element.

      Returns:
      the HTML