openHAB Core

https://www.openhab.org/javadoc/latest
Admin
openHAB Core is the Java-based core framework for openHAB, an open-source, vendor-neutral home...
Tokens:41,797
Snippets:781
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### install(Addon addon)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/marketplace/marketplaceaddonhandler

Installs a given add-on.

```APIDOC
## void install(Addon addon)

### Description
Installs a given add-on. This method is only called if the handler claimed support for the add-on.

### Parameters
- **addon** (Addon) - The add-on to install.

### Throws
- **MarketplaceHandlerException** - If the installation failed for some reason.
```

--------------------------------

### createAddonInstalledEvent(String id)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/addoneventfactory

Creates an event representing the successful installation of an add-on.

```APIDOC
### static AddonEvent createAddonInstalledEvent(String id)

Creates an "add-on installed" event.

#### Parameters
- **id** (String) - The ID of the installed add-on.

#### Returns
- **AddonEvent** - The created event instance.
```

--------------------------------

### startDialog

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiodialogprovider

Starts a dialog and returns a runnable that triggers it or null if the dialog initialization fails.

```APIDOC
## startDialog

### Description
Starts a dialog and returns a runnable that triggers it or null if the dialog initialization fails.

### Signature
`@Nullable Runnable startDialog(AudioSink audioSink, AudioSource audioSource, @Nullable String locationItem, @Nullable String listeningItem, @Nullable Runnable onAbort)`

### Parameters
- **audioSink** (AudioSink) - Required - The audio sink to play sound.
- **audioSource** (AudioSource) - Required - The audio source to capture sound.
- **locationItem** (String) - Optional - An optional Item name to scope dialog commands.
- **listeningItem** (String) - Optional - An optional Item name to toggle while dialog is listening, overwrites default.
- **onAbort** (Runnable) - Optional - An optional Runnable instance to call on abort.

### Returns
- **Runnable** - A Runnable instance to trigger dialog processing or null if the dialog initialization fails.
```

--------------------------------

### isInstalled(String id)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/marketplace/marketplaceaddonhandler

Checks if a specific add-on is currently installed.

```APIDOC
## boolean isInstalled(String id)

### Description
Tells whether a given add-on is currently installed. This method is only called if the handler claimed support for the add-on.

### Parameters
- **id** (String) - The id of the add-on in question.

### Returns
- **boolean** - true if the add-on is installed, false otherwise.
```

--------------------------------

### HTTP Redirect Example

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/client/oauth2/oauthclientservice

Example of an HTTP 302 redirect response containing authorization code and state parameters.

```http
HTTP/1.1 302 Found
Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz
```

--------------------------------

### get(String scope, String thingUid)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/automation/module/script/defaultscope/scriptthingactions

Retrieves an actions instance for a specific scope and thing UID.

```APIDOC
## get(String scope, String thingUid)

### Description
Gets an actions instance of a certain scope for a given thing UID.

### Parameters
- **scope** (String) - The action scope.
- **thingUid** (String) - The UID of the thing.

### Returns
- **ThingActions** - The actions instance or null if not available.
```

--------------------------------

### serve(AudioStream, int, boolean)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiohttpserver

Creates a relative URL for an AudioStream, allowing it to be requested one or multiple times within a specified time frame.

```APIDOC
## Method: serve(AudioStream stream, int seconds, boolean multiTimeStream)

### Description
Creates a relative URL for a given AudioStream where it can be requested one or multiple times within the given time frame. If multiTimeStream is true, the stream is made cloneable if it is not already.

### Parameters
- **stream** (AudioStream) - Required - The stream to serve on HTTP.
- **seconds** (int) - Required - Number of seconds for which the stream is available through HTTP.
- **multiTimeStream** (boolean) - Required - Set to true if this stream should be played multiple times.

### Returns
- **StreamServed** - Information about the served stream, including the relative URL and a CompletableFuture to track playback completion.

### Throws
- **IOException** - Thrown when the stream is not a ClonableAudioStream and cannot be stored on disk.
```

--------------------------------

### isReady()

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/marketplace/marketplaceaddonhandler

Checks if the handler is ready to accept requests.

```APIDOC
## default boolean isReady()

### Description
Checks if the add-on handler is ready to accept requests after instantiation. This is useful if initialization takes time.

### Returns
- **boolean** - true if the initialization finished.
```

--------------------------------

### getInputStream(AudioFormat format)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiosource

Gets an AudioStream for reading audio data in a supported audio format.

```APIDOC
## AudioStream getInputStream(AudioFormat format)

### Description
Gets an AudioStream for reading audio data in supported audio format.

### Parameters
- **format** (AudioFormat) - Required - The expected audio format of the stream.

### Returns
- **AudioStream** - AudioStream for reading audio data.

### Throws
- **AudioException** - If a problem occurs obtaining the stream.
```

--------------------------------

### playFile(String, String, PercentType)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiomanager

Plays an audio file from the sounds folder on a specified sink at a given volume.

```APIDOC
### Method
void playFile(String fileName, @Nullable String sinkId, @Nullable PercentType volume)

### Description
Plays an audio file from the "sounds" folder using the given audio sink at the specified volume.

### Parameters
- **fileName** (String) - The file from the "sounds" folder.
- **sinkId** (String) - The id of the audio sink to use or null for the default.
- **volume** (PercentType) - The volume to be used.
```

--------------------------------

### playFile

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiomanager

Plays an audio file from the 'sounds' folder using a specified or default audio sink and volume.

```APIDOC
### playFile(String fileName, @Nullable PercentType volume)
### playFile(String fileName, @Nullable String sinkId)
### playFile(String fileName, @Nullable String sinkId, @Nullable PercentType volume)

Plays an audio file from the 'sounds' folder. 

Parameters:
- **fileName** (String) - The file from the 'sounds' folder.
- **volume** (PercentType) - The volume to be used or null if the default notification volume should be used.
- **sinkId** (String) - The id of the audio sink to use or null for the default.

Throws:
- **AudioException** - in case the file does not exist or cannot be opened.
```

--------------------------------

### getAddonInfos()

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/addoninforegistry

Retrieves all add-on information contained in the registry.

```APIDOC
## getAddonInfos()

### Description
Returns all add-on information this registry contains.

### Returns
- **Set<AddonInfo>** - A set of all add-on information (not null, could be empty).
```

--------------------------------

### Get Access Token Response

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/client/oauth2/oauthclientservice

Retrieves the current access token, automatically handling expiration and refresh tokens if available.

```java
@Nullable AccessTokenResponse getAccessTokenResponse() throws OAuthException, IOException, OAuthResponseException
```

--------------------------------

### record(int, String, String)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiomanager

Records audio to a WAV file in the sounds folder.

```APIDOC
### Method
void record(int seconds, String filename, @Nullable String sourceId)

### Description
Record audio as a WAV file of the specified length to the sounds folder.

### Parameters
- **seconds** (int) - The duration of the recording in seconds.
- **filename** (String) - The name of the file to save.
- **sourceId** (String) - The id of the audio source to use.
```

--------------------------------

### Get Device Code Response

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/client/oauth2/oauthclientservice

Initiates the RFC-8628 Device Code Grant Flow to obtain verification URIs for user authentication.

```java
@Nullable DeviceCodeResponseDTO getDeviceCodeResponse() throws OAuthException
```

--------------------------------

### Get Access Token by Implicit Grant

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/client/oauth2/oauthclientservice

Handles the implicit grant flow, typically used in browser or JavaScript-based redirection scenarios.

```java
AccessTokenResponse getAccessTokenByImplicit(@Nullable String redirectURI, @Nullable String scope, @Nullable String state) throws OAuthException, IOException, OAuthResponseException
```

--------------------------------

### Get Access Token by Client Credentials

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/client/oauth2/oauthclientservice

Retrieves an access token using only client credentials, without involving a human resource owner.

```java
AccessTokenResponse getAccessTokenByClientCredentials(@Nullable String scope) throws OAuthException, IOException, OAuthResponseException
```

--------------------------------

### AddonInfoList()

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/addoninfolist

Constructs a new AddonInfoList instance.

```APIDOC
### Constructor
`public AddonInfoList()`

Creates an empty instance of the AddonInfoList DTO.
```

--------------------------------

### Authentication authenticate(Credentials credentials)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/authenticationmanager

Attempts to authenticate using the provided credentials. Throws an AuthenticationException if authentication fails.

```APIDOC
## authenticate(Credentials credentials)

### Description
Performs an authentication attempt with the specified credentials. This is the primary method for verifying the originator of a request.

### Parameters
- **credentials** (Credentials) - Required - The credentials object used for the authentication attempt.

### Returns
- **Authentication** - Returns an Authentication object upon success. A null value is never returned.

### Throws
- **AuthenticationException** - Thrown when the authentication attempt fails for any reason, including when no available authentication methods succeed.
```

--------------------------------

### Get Access Token by Resource Owner Password Credentials

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/client/oauth2/oauthclientservice

Authenticates using direct user credentials when the username and password are known to the client.

```java
AccessTokenResponse getAccessTokenByResourceOwnerPasswordCredentials(String username, String password, @Nullable String scope) throws OAuthException, IOException, OAuthResponseException
```

--------------------------------

### startParsingFormat

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/automation/converter/ruletemplateparser

Parses the provided syntax string without impacting the rule template registry.

```APIDOC
## String startParsingFormat(String syntax, List<String> errors, List<String> warnings)

### Description
Parses the provided syntax string without impacting the rule template registry.

### Parameters
- **syntax** (String) - The syntax in format.
- **errors** (List<String>) - The list to use to report errors.
- **warnings** (List<String>) - The list to be used to report warnings.

### Returns
- **String** - The model name used for parsing if the parsing succeeded without errors; null otherwise.
```

--------------------------------

### Get Access Token Response by Authorization Code

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/client/oauth2/oauthclientservice

Retrieves an access token using an authorization code, following the RFC 6749 Authorization Code Grant flow.

```java
AccessTokenResponse getAccessTokenResponseByAuthorizationCode(String authorizationCode, @Nullable String redirectURI) throws OAuthException, IOException, OAuthResponseException
```

--------------------------------

### AudioFormat Constructor

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audioformat

Constructs an instance of AudioFormat with specified properties. Null values indicate that any value is allowed for that property.

```APIDOC
## Constructor: AudioFormat(String container, String codec, Boolean bigEndian, Integer bitDepth, Integer bitRate, Long frequency, Integer channels)

### Description
Creates a new AudioFormat instance. Properties set to null act as wildcards, allowing any value for that specific attribute.

### Parameters
- **container** (String) - Optional - The container format.
- **codec** (String) - Optional - The audio codec.
- **bigEndian** (Boolean) - Optional - Endianness of the audio data.
- **bitDepth** (Integer) - Optional - Bit depth of the audio data.
- **bitRate** (Integer) - Optional - Bit rate of the audio.
- **frequency** (Long) - Optional - Sampling frequency.
- **channels** (Integer) - Optional - Number of audio channels.
```

--------------------------------

### getBestMatch

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audioformat

Finds the best matching format between two sets of audio formats.

```APIDOC
## Method: getBestMatch(Set<AudioFormat> inputs, Set<AudioFormat> outputs)

### Description
Determines the best match between a set of formats supported by a source and a set supported by a sink.

### Parameters
- **inputs** (Set<AudioFormat>) - Required - Supported formats of the source.
- **outputs** (Set<AudioFormat>) - Required - Supported formats of the sink.

### Returns
- **AudioFormat** - The best matching format, or null if no compatible format exists.
```

--------------------------------

### getAddonInfo(String uid)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/addoninforegistry

Retrieves the add-on information for a specific add-on UID.

```APIDOC
## getAddonInfo(String uid)

### Description
Returns the add-on information for the specified add-on UID, or null if no add-on information could be found.

### Parameters
- **uid** (String) - Required - The UID to be looked up.

### Returns
- **AddonInfo** - The add-on information object, or null if not found.
```

--------------------------------

### UnsupportedAudioFormatException Constructors

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/unsupportedaudioformatexception

Constructors for creating a new instance of the UnsupportedAudioFormatException.

```APIDOC
## Constructor: UnsupportedAudioFormatException(String message, AudioFormat unsupportedFormat)

### Description
Constructs a new exception with the specified detail message and unsupported format.

### Parameters
- **message** (String) - Detail message
- **unsupportedFormat** (AudioFormat) - Unsupported format

## Constructor: UnsupportedAudioFormatException(String message, AudioFormat unsupportedFormat, Throwable cause)

### Description
Constructs a new exception with the specified detail message, unsupported format, and cause.

### Parameters
- **message** (String) - Detail message
- **unsupportedFormat** (AudioFormat) - Unsupported format
- **cause** (Throwable) - The cause
```

--------------------------------

### getSupportedFormats()

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiosource

Obtains the audio formats supported by the AudioSource.

```APIDOC
## Set<AudioFormat> getSupportedFormats()

### Description
Obtain the audio formats supported by this AudioSource.

### Returns
- **Set<AudioFormat>** - The audio formats supported by this service.
```

--------------------------------

### record

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiomanager

Records audio as a WAV file of a specified length to the sounds folder.

```APIDOC
### record(int seconds, String filename, @Nullable String sourceId)

Record audio as a WAV file of the specified length.

Parameters:
- **seconds** (int) - Seconds to record.
- **filename** (String) - Record filename.
- **sourceId** (String) - The id of the audio source to use or null for the default.

Throws:
- **AudioException**
```

--------------------------------

### AuthenticationProvider Methods

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/authenticationprovider

Methods available for implementing or interacting with an AuthenticationProvider.

```APIDOC
## Authentication authenticate(Credentials credentials)

### Description
Verify given credentials and return an authentication object if they are valid.

### Parameters
- **credentials** (Credentials) - User credentials to verify.

### Returns
- **Authentication** - The authentication object defining access scope, or null if credentials are invalid.

### Throws
- **AuthenticationException** - If authentication failed due to a credentials mismatch.

## boolean supports(Class<? extends Credentials> type)

### Description
Verify if the authentication provider can handle a specific type of credentials.

### Parameters
- **type** (Class<? extends Credentials>) - The type of credentials to check.

### Returns
- **boolean** - True if the credentials type is supported, false otherwise.
```

--------------------------------

### isCompatible

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audioformat

Checks if a given AudioFormat is compatible with the current instance.

```APIDOC
## Method: isCompatible(AudioFormat audioFormat)

### Description
Determines if the provided AudioFormat is compatible with this instance. Compatibility is defined as having the same values for all non-null members of this instance.

### Parameters
- **audioFormat** (AudioFormat) - Optional - The format to check against.
```

--------------------------------

### startParsingFormat

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/automation/converter/ruleparser

Parses a provided syntax string to validate rule formatting without affecting the rule registry.

```APIDOC
## startParsingFormat

### Description
Parses the provided syntax string without impacting the rule registry. Returns the model name if successful, or null otherwise.

### Method
Java Interface Method

### Parameters
- **syntax** (String) - Required - The syntax in format.
- **errors** (List<String>) - Required - The list to use to report errors.
- **warnings** (List<String>) - Required - The list to be used to report warnings.

### Returns
- **String** - The model name used for parsing if the parsing succeeded without errors; null otherwise.
```

--------------------------------

### getAddonInfo(String uid, Locale locale)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/addoninforegistry

Retrieves the localized add-on information for a specific add-on UID.

```APIDOC
## getAddonInfo(String uid, Locale locale)

### Description
Returns the add-on information for the specified add-on UID and locale, or null if no add-on information could be found. If multiple providers exist, it returns a merged AddonInfo object.

### Parameters
- **uid** (String) - Required - The UID to be looked up.
- **locale** (Locale) - Optional - The locale to be used for the add-on information.

### Returns
- **AddonInfo** - The localized add-on information object, or null if not found.
```

--------------------------------

### getAddons()

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/addoninfolist

Retrieves the list of addons contained in this DTO.

```APIDOC
### Method
`public List<AddonInfo> getAddons()`

Returns the list of `AddonInfo` objects currently stored in the DTO.
```

--------------------------------

### play(AudioStream, String, PercentType)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiomanager

Plays an audio stream on a specified sink at a given volume.

```APIDOC
### Method
void play(@Nullable AudioStream audioStream, @Nullable String sinkId, @Nullable PercentType volume)

### Description
Plays the passed audio stream on the given sink. If sinkId is null, the default sink is used. If volume is null, the default notification volume is used.

### Parameters
- **audioStream** (AudioStream) - The audio stream to play or null if streaming should be stopped.
- **sinkId** (String) - The id of the audio sink to use or null for the default.
- **volume** (PercentType) - The volume to be used or null if the default notification volume should be used.
```

--------------------------------

### Addon.Builder Methods

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/addon.builder

The Addon.Builder class provides a set of methods to configure an Addon object before calling the build() method.

```APIDOC
## Addon.Builder Methods

### Description
The Addon.Builder class is used to construct an Addon instance. Each method returns the builder instance to allow for method chaining.

### Methods
- **withId(String id)**: Sets the ID of the addon.
- **withLabel(String label)**: Sets the label of the addon.
- **withVersion(String version)**: Sets the version of the addon.
- **withType(String type)**: Sets the type of the addon.
- **withMaturity(String maturity)**: Sets the maturity level of the addon.
- **withCompatible(boolean compatible)**: Sets the compatibility status.
- **withInstalled(boolean installed)**: Sets the installation status.
- **withDescription(String description)**: Sets the description.
- **withDetailedDescription(String detailedDescription)**: Sets the detailed description.
- **withAuthor(String author)** / **withAuthor(String author, boolean verifiedAuthor)**: Sets the author information.
- **withProperty(String key, Object value)**: Adds a single property.
- **withProperties(Map<String, Object> properties)**: Sets multiple properties.
- **build()**: Constructs and returns the final Addon object.
```

--------------------------------

### processAndComplete(AudioStream audioStream)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiosinksync

Processes the provided audio stream and returns a CompletableFuture that completes when playback is finished.

```APIDOC
## processAndComplete(AudioStream audioStream)

### Description
Processes the passed AudioStream and returns a CompletableFuture that should complete when the sound is fully played. If the stream is null, it is interpreted as a request to end any currently playing stream.

### Parameters
- **audioStream** (AudioStream) - The audio stream to play or null to keep quiet.

### Returns
- **CompletableFuture<Void>** - A future completed when the sound is fully played. May complete with UnsupportedAudioFormatException or UnsupportedAudioStreamException.
```

--------------------------------

### getId()

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/audiosource

Returns a simple string that uniquely identifies the audio service.

```APIDOC
## String getId()

### Description
Returns a simple string that uniquely identifies this service.

### Returns
- **String** - An id that identifies this service.
```

--------------------------------

### supports(String type, String contentType)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/marketplace/marketplaceaddonhandler

Checks if the handler supports a specific add-on type and content type.

```APIDOC
## boolean supports(String type, String contentType)

### Description
Tells whether this handler supports a given add-on based on its type and content type.

### Parameters
- **type** (String) - The type of the add-on in question.
- **contentType** (String) - The content type of the add-on in question.

### Returns
- **boolean** - true if the addon type and contentType are supported, false otherwise.
```

--------------------------------

### getAddonInfos(Locale locale)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/addoninforegistry

Retrieves all add-on information in the specified locale.

```APIDOC
## getAddonInfos(Locale locale)

### Description
Returns all add-on information in the specified locale that this registry contains.

### Parameters
- **locale** (Locale) - Optional - The locale to be used for the add-on information.

### Returns
- **Set<AddonInfo>** - A localized set of all add-on information (not null, could be empty).
```

--------------------------------

### createAddonUninstalledEvent(String id)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/addon/addoneventfactory

Creates an event representing the uninstallation of an add-on.

```APIDOC
### static AddonEvent createAddonUninstalledEvent(String id)

Creates an "add-on uninstalled" event.

#### Parameters
- **id** (String) - The ID of the uninstalled add-on.

#### Returns
- **AddonEvent** - The created event instance.
```

--------------------------------

### getUnsupportedFormat()

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/audio/unsupportedaudioformatexception

Retrieves the audio format that caused the exception.

```APIDOC
## Method: getUnsupportedFormat()

### Description
Gets the unsupported format.

### Returns
- **AudioFormat** - The unsupported format
```

--------------------------------

### sendCommand

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/automation/module/script/action/busevent

Sends a command for a specified item to the event bus.

```APIDOC
## void sendCommand(Item item, Command command)

### Description
Sends a command for a specified item to the event bus.

### Parameters
- **item** (Item) - Required - The item to send the command to
- **command** (Command) - Required - The command to send
```

```APIDOC
## void sendCommand(Item item, Command command, String source)

### Description
Sends a command for a specified item to the event bus with an optional source.

### Parameters
- **item** (Item) - Required - The item to send the command to
- **command** (Command) - Required - The command to send
- **source** (String) - Optional - The source of the command
```

--------------------------------

### compile()

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/automation/handler/conditionhandler

Compiles the condition when the rule is initialized.

```APIDOC
## void compile()

### Description
Called to compile the Condition when the Rule is initialized.

### Throws
- Exception - if the compilation fails
```

--------------------------------

### Transformation.transform(String serviceName, String function, String value)

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/transform/actions/package-summary

Executes a transformation using a specified service and function on a given input value.

```APIDOC
## Transformation.transform

### Description
Executes a transformation on a provided string value using the specified transformation service and function.

### Signature
`public static String transform(String serviceName, String function, String value)`

### Parameters
- **serviceName** (String) - The name of the transformation service to use (e.g., "MAP", "REGEX").
- **function** (String) - The specific transformation function or mapping file to apply.
- **value** (String) - The input value to be transformed.

### Returns
- **String** - The transformed result, or the original value if the transformation fails.
```

--------------------------------

### Import Access Token Response

Source: https://www.openhab.org/javadoc/latest/org/openhab/core/auth/client/oauth2/oauthclientservice

Imports or migrates an existing AccessTokenResponse into the service storage.

```java
void importAccessTokenResponse(AccessTokenResponse accessTokenResponse) throws OAuthException
```
Tokens:
Raw