Package com.adobe.cq.wcm.core.components.services.embed

Interface OEmbedResponse

@ConsumerType public interface OEmbedResponse
Defines the oEmbed HTTP response object. All standard oEmbed response parameters are supported.
Since:
com.adobe.cq.wcm.core.components.services.embed 1.0.0
See Also:

  • Method Details

    • getType

      @NotNull @NotNull String getType()
      The oEmbed type.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getVersion

      @NotNull @NotNull String getVersion()
      The oEmbed version number.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getTitle

      @Nullable @Nullable String getTitle()
      A text title, describing the resource.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getAuthorName

      @Nullable @Nullable String getAuthorName()
      The name of the author/owner of the resource.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getAuthorUrl

      @Nullable @Nullable String getAuthorUrl()
      A URL for the author/owner of the resource.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getProviderName

      @Nullable @Nullable String getProviderName()
      The name of the resource provider.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getProviderUrl

      @Nullable @Nullable String getProviderUrl()
      The url of the resource provider.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getCacheAge

      @Nullable @Nullable Long getCacheAge()
      The suggested cache lifetime for this resource, in seconds.
      Returns:
      a Long object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getThumbnailUrl

      @Nullable @Nullable String getThumbnailUrl()
      A URL to a thumbnail image representing the resource.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getThumbnailWidth

      @Nullable @Nullable String getThumbnailWidth()
      The width of the optional thumbnail.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getThumbnailHeight

      @Nullable @Nullable String getThumbnailHeight()
      The height of the optional thumbnail.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getWidth

      @Nullable @Nullable String getWidth()
      The width in pixels required to display the HTML.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getHeight

      @Nullable @Nullable String getHeight()
      The height in pixels required to display the HTML.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getHtml

      @Nullable @Nullable String getHtml()
      The HTML required to display the resource.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0

    • getUrl

      @Nullable @Nullable String getUrl()
      The source URL of the image.
      Returns:
      a String object
      Since:
      com.adobe.cq.wcm.core.components.models.embed 1.0.0