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 String
getAuthorName()
The name of the author/owner of the resource.@Nullable String
getAuthorUrl()
A URL for the author/owner of the resource.@Nullable Long
getCacheAge()
The suggested cache lifetime for this resource, in seconds.@Nullable String
getHeight()
The height in pixels required to display the HTML.@Nullable String
getHtml()
The HTML required to display the resource.@Nullable String
getProviderName()
The name of the resource provider.@Nullable String
getProviderUrl()
The url of the resource provider.@Nullable String
getThumbnailHeight()
The height of the optional thumbnail.@Nullable String
getThumbnailUrl()
A URL to a thumbnail image representing the resource.@Nullable String
getThumbnailWidth()
The width of the optional thumbnail.@Nullable String
getTitle()
A text title, describing the resource.@NotNull String
getType()
The oEmbed type.@Nullable String
getUrl()
The source URL of the image.@NotNull String
getVersion()
The oEmbed version number.@Nullable String
getWidth()
The width in pixels required to display the HTML.
-
-
-
Method Detail
-
getType
@NotNull @NotNull String getType()
The oEmbed type.- Since:
- com.adobe.cq.wcm.core.components.models.embed 1.0.0
-
getVersion
@NotNull @NotNull String getVersion()
The oEmbed version number.- Since:
- com.adobe.cq.wcm.core.components.models.embed 1.0.0
-
getTitle
@Nullable @Nullable String getTitle()
A text title, describing the resource.- 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.- 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.- Since:
- com.adobe.cq.wcm.core.components.models.embed 1.0.0
-
getProviderName
@Nullable @Nullable String getProviderName()
The name of the resource provider.- Since:
- com.adobe.cq.wcm.core.components.models.embed 1.0.0
-
getProviderUrl
@Nullable @Nullable String getProviderUrl()
The url of the resource provider.- 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.- 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.- Since:
- com.adobe.cq.wcm.core.components.models.embed 1.0.0
-
getThumbnailWidth
@Nullable @Nullable String getThumbnailWidth()
The width of the optional thumbnail.- Since:
- com.adobe.cq.wcm.core.components.models.embed 1.0.0
-
getThumbnailHeight
@Nullable @Nullable String getThumbnailHeight()
The height of the optional thumbnail.- 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.- 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.- Since:
- com.adobe.cq.wcm.core.components.models.embed 1.0.0
-
getHtml
@Nullable @Nullable String getHtml()
The HTML required to display the resource.- Since:
- com.adobe.cq.wcm.core.components.models.embed 1.0.0
-
getUrl
@Nullable @Nullable String getUrl()
The source URL of the image.- Since:
- com.adobe.cq.wcm.core.components.models.embed 1.0.0
-
-