Captcha (The Adobe Experience Manager Forms SDK 2025.03.13.02-250500)

All Superinterfaces:

Base, BaseConstraint, Component, com.adobe.cq.export.json.ComponentExporter, Field, FormComponent

All Known Subinterfaces:

HCaptcha, Turnstile

All Known Implementing Classes:

AbstractCaptchaImpl, AbstractCaptchaImplV2
```
@ConsumerType
public interface Captcha
extends Field
```
Defines a base interface to be extended by all the different types of captcha.

Since:

com.adobe.cq.forms.core.components.models.form 2.0.0

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Captcha.CaptchaDisplayMode
Defines the display mode for captcha.
- Nested classes/interfaces inherited from interface com.adobe.cq.forms.core.components.models.form.BaseConstraint
  BaseConstraint.Type

Field Summary
- Fields inherited from interface com.adobe.cq.forms.core.components.models.form.Base
  DATE_FORMATTER, DEFAULT_LANGUAGE
- Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component
  PN_ID
- Fields inherited from interface com.adobe.cq.forms.core.components.models.form.FormComponent
  CUSTOM_PROPERTY_WRAPPER

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default java.lang.String`	`getCaptchaDisplayMode()`	Returns the display mode of the captcha component.
`java.util.Map<java.lang.String,java.lang.Object>`	`getCaptchaProperties()`
`default java.lang.String`	`getCaptchaSiteKey()`	Returns the site key of the captcha component.
`default java.lang.String`	`getCloudServicePath()`
`java.lang.String`	`getProvider()`
`java.lang.String`	`getSize()`

Methods inherited from interface com.adobe.cq.forms.core.components.models.form.Base
getConstraintMessages, getDescription, getExportedType, getHtmlScreenReaderText, getLabel, getLang, getScreenReaderText, getTooltip, isEnabled, isTooltipVisible

Methods inherited from interface com.adobe.cq.forms.core.components.models.form.BaseConstraint
getType, getValidationExpression, isRequired

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component
getAppliedCssClasses, getData, getId

Methods inherited from interface com.adobe.cq.forms.core.components.models.form.Field
getDataFormat, getDefault, getDisplayFormat, getDisplayValueExpression, getEditFormat, getPlaceHolder, isReadOnly

Methods inherited from interface com.adobe.cq.forms.core.components.models.form.FormComponent
getDataRef, getDorProperties, getEvents, getFieldType, getName, getPath, getProperties, getRules, isVisible, setI18n

- Method Detail
  - getCloudServicePath
```
default java.lang.String getCloudServicePath()
```
  - getSize
```
java.lang.String getSize()
```
  - getProvider
```
java.lang.String getProvider()
```
  - getCaptchaProperties
```
java.util.Map<java.lang.String,java.lang.Object> getCaptchaProperties()
                                                                     throws GuideException
```
    Throws:
    
    GuideException
  - getCaptchaDisplayMode
```
default java.lang.String getCaptchaDisplayMode()
```
    Returns the display mode of the captcha component.
    
    Returns:
    
    the string value of the one of the Captcha.CaptchaDisplayMode enum
    
    Since:
    
    com.adobe.cq.forms.core.components.models.form 5.10.0
  - getCaptchaSiteKey
```
default java.lang.String getCaptchaSiteKey()
```
    Returns the site key of the captcha component.
    
    Returns:
    
    the site key
    
    Since:
    
    com.adobe.cq.forms.core.components.models.form 5.10.0