@ConsumerType public interface Embed extends ComponentExporter
Embed
Sling Model used for the /apps/core/wcm/components/embed
component.Modifier and Type | Interface and Description |
---|---|
static class |
Embed.Type
Enumeration of the supported embed input types.
|
Modifier and Type | Field and Description |
---|---|
static String |
PN_DESIGN_ALLOWED_EMBEDDABLES
Name of the configuration policy property that defines the embeddables that are allowed to be selected
by an author.
|
static String |
PN_DESIGN_EMBEDDABLES_DISABLED
Name of the configuration policy property that indicates whether the embeddable input type is disabled.
|
static String |
PN_DESIGN_HTML_DISABLED
Name of the configuration policy property that indicates whether the html input type is disabled.
|
static String |
PN_DESIGN_URL_DISABLED
Name of the configuration policy property that indicates whether the url input type is disabled.
|
static String |
PN_EMBEDDABLE_RESOURCE_TYPE
Name of the resource property that defines the resource type of an embeddable.
|
static String |
PN_HTML
Name of the resource property that defines an embeddable HTML snippet.
|
static String |
PN_TYPE
Name of the resource property that defines the embed input
Embed.Type . |
static String |
PN_URL
Name of the resource property that defines the URL of an embeddable item.
|
static String |
RT_EMBEDDABLE_V1
Resource type of an embeddable.
|
Modifier and Type | Method and Description |
---|---|
default @Nullable String |
getEmbeddableResourceType()
Returns the resource type of the embeddable.
|
default @NotNull String |
getExportedType()
Returns the type of the resource for which the export is performed.
|
default @Nullable String |
getHtml()
Returns an embeddable HTML snippet.
|
default UrlProcessor.Result |
getResult()
Returns the result from the processor that can process the given URL.
|
default @Nullable Embed.Type |
getType()
Returns the embed input
Embed.Type . |
default @Nullable String |
getUrl()
Returns the URL of an embeddable item.
|
static final String PN_DESIGN_URL_DISABLED
static final String PN_DESIGN_EMBEDDABLES_DISABLED
static final String PN_DESIGN_HTML_DISABLED
static final String PN_DESIGN_ALLOWED_EMBEDDABLES
static final String PN_TYPE
Embed.Type
.static final String PN_URL
static final String PN_HTML
static final String PN_EMBEDDABLE_RESOURCE_TYPE
static final String RT_EMBEDDABLE_V1
@Nullable default @Nullable Embed.Type getType()
Embed.Type
.Embed.Type
, or null
if no type is found@Nullable default @Nullable String getUrl()
Embed.Type.URL
and the url type is not disabled via policy configuration, null
otherwise@Nullable default UrlProcessor.Result getResult()
null
if processing is not possible@Nullable default @Nullable String getEmbeddableResourceType()
Embed.Type.EMBEDDABLE
and the embeddable type is not disabled via policy configuration, null
otherwise@Nullable default @Nullable String getHtml()
String
, if type is Embed.Type.HTML
and the html type is not disabled via policy configuration, null
otherwise@NotNull default @NotNull String getExportedType()
ComponentExporter
Returns the type of the resource for which the export is performed.
NOTE: methods whose JSON serialization would lead to the same JSON property name (":type") will not be serialized.
getExportedType
in interface ComponentExporter
ComponentExporter.getExportedType()
Copyright © 2010 - 2020 Adobe. All Rights Reserved