IPromptConnectionConfig_ApiKey (formcycle: bom 8.5.6 API)

All Known Implementing Classes:

GenericOaiConnectionConfig
```
public interface IPromptConnectionConfig_ApiKey
```
Mixin for a prompt query configuration model that allows the user to configure the API key, i.e. the token needed to authenticate with the prompt service provider.
Use of this mixin is optional, but ensures a consistent name for the property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured data.
See also the <xp:apiKey/> Faces component from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

Since:

8.5.0

Field Summary

Fields
Modifier and Type Field Description

static String ATTR_API_KEY
The name of the API key attribute.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getApiKey()`	Gets the API key, i.e. the token needed to authenticate with the prompt service provider.
`void`	`setApiKey(String apiKey)`	Sets the API key, i.e. the token needed to authenticate with the prompt service provider.

- Field Detail
  - ATTR_API_KEY
```
static final String ATTR_API_KEY
```
    The name of the API key attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getApiKey
```
String getApiKey()
```
    Gets the API key, i.e. the token needed to authenticate with the prompt service provider.
    
    Returns:
    
    The API key.
  - setApiKey
```
void setApiKey(String apiKey)
```
    Sets the API key, i.e. the token needed to authenticate with the prompt service provider.
    
    Parameters:
    
    apiKey - The API key to set.