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:
    https://oembed.com/#section2.3

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  OEmbedResponse.Format
      Enumeration of oEmbed response formats.
      static class  OEmbedResponse.Type
      Enumeration of oEmbed response types.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @Nullable java.lang.String getAuthorName()
      The name of the author/owner of the resource.
      @Nullable java.lang.String getAuthorUrl()
      A URL for the author/owner of the resource.
      @Nullable java.lang.Long getCacheAge()
      The suggested cache lifetime for this resource, in seconds.
      @Nullable java.lang.String getHeight()
      The height in pixels required to display the HTML.
      @Nullable java.lang.String getHtml()
      The HTML required to display the resource.
      @Nullable java.lang.String getProviderName()
      The name of the resource provider.
      @Nullable java.lang.String getProviderUrl()
      The url of the resource provider.
      @Nullable java.lang.String getThumbnailHeight()
      The height of the optional thumbnail.
      @Nullable java.lang.String getThumbnailUrl()
      A URL to a thumbnail image representing the resource.
      @Nullable java.lang.String getThumbnailWidth()
      The width of the optional thumbnail.
      @Nullable java.lang.String getTitle()
      A text title, describing the resource.
      @NotNull java.lang.String getType()
      The oEmbed type.
      @Nullable java.lang.String getUrl()
      The source URL of the image.
      @NotNull java.lang.String getVersion()
      The oEmbed version number.
      @Nullable java.lang.String getWidth()
      The width in pixels required to display the HTML.

    • Method Detail

      • getType

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

      • getVersion

        @NotNull
@NotNull java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String getUrl()
        The source URL of the image.
        Returns:
        a String object
        Since:
        com.adobe.cq.wcm.core.components.models.embed 1.0.0