Jump to: navigation, search
(Created target blank page For Version: HTCC:9.0.0)
 
(Update with the copy of version: 9.0.0DRAFT)
 
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
= Configuration namespace =
 +
==Methods==
 +
The Configuration namespace includes the following methods:
 +
* [[ConfigurationNamespace#getOption|getOption]]
 +
 
 +
===getOption===
 +
{|
 +
! Signature
 +
| <static> getOption(''options'') → {Array.<[[ConfigurationNamespace#Section|Section]]>}
 +
|-
 +
! Description
 +
| Get configuration options and values for a specific option name or a subset of options from the '''[interaction-workspace]''' section or a custom section.
 +
|-
 +
! Parameters
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Argument
 +
! Description
 +
|-
 +
| options
 +
| string
 +
|
 +
| An array of configuration options or sections to return. Unless otherwise specified, the API will return options from the '''[interaction-workspace]''' section by default. You can specify any of the following:
 +
* A single option: <tt>genesys.wwe.service.configuration.getOption('voice.auto-answer', succeeded, failed)</tt>
 +
* A single option in a specific section: <tt>genesys.wwe.service.configuration.getOption('CustomSection/option.custom.customer.code', succeeded, failed)</tt>
 +
* Multiple options: <tt>genesys.wwe.service.configuration.getOption(['voice.auto-answer', 'privilege.email.can-mark-done'], succeeded, failed)</tt>
 +
* Multiple options in different sections: <tt>genesys.wwe.service.configuration.getOption(['privilege.*', 'CustomSection/option.custom.customer.code'], succeeded, failed)</tt>
 +
You can use an asterisk '*' as a wildcard, but only at the end of each word. For example:
 +
* voice.*
 +
* voice.auto*
 +
* sipendpoint.*
 +
* CustomAPI/test.*
 +
You cannot use an asterisk at the start of an option or section. For example, the following values are not allowed:
 +
* <nowiki>*.mark-done</nowiki>
 +
* <nowiki>*.auto</nowiki>
 +
|}
 +
|-
 +
! Returns
 +
| Array.<[[ConfigurationNamespace#Section|Section]]>
 +
|}
 +
 
 +
==Type definitions==
 +
The Configuration namespace includes the following object types:
 +
* [[ConfigurationNamespace#Section|Section]]
 +
 
 +
===Section===
 +
{|
 +
! Description
 +
| Represents the JSON structure of a configuration section. Each section includes a list of key/value pairs for the matching option(s).
 +
|-
 +
! Type
 +
| Object
 +
|-
 +
! Properties
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| name
 +
| string
 +
| The name of the configuration option.
 +
|-
 +
| value
 +
| string or array of strings
 +
| The value of the configuration option.
 +
|}
 +
|}
 +
 
 +
[[Category:V:HTCC:9.0.0]]

Latest revision as of 14:19, July 20, 2021

Configuration namespace

Methods

The Configuration namespace includes the following methods:

getOption

Signature <static> getOption(options) → {Array.<Section>}
Description Get configuration options and values for a specific option name or a subset of options from the [interaction-workspace] section or a custom section.
Parameters
Name Type Argument Description
options string An array of configuration options or sections to return. Unless otherwise specified, the API will return options from the [interaction-workspace] section by default. You can specify any of the following:
  • A single option: genesys.wwe.service.configuration.getOption('voice.auto-answer', succeeded, failed)
  • A single option in a specific section: genesys.wwe.service.configuration.getOption('CustomSection/option.custom.customer.code', succeeded, failed)
  • Multiple options: genesys.wwe.service.configuration.getOption(['voice.auto-answer', 'privilege.email.can-mark-done'], succeeded, failed)
  • Multiple options in different sections: genesys.wwe.service.configuration.getOption(['privilege.*', 'CustomSection/option.custom.customer.code'], succeeded, failed)

You can use an asterisk '*' as a wildcard, but only at the end of each word. For example:

  • voice.*
  • voice.auto*
  • sipendpoint.*
  • CustomAPI/test.*

You cannot use an asterisk at the start of an option or section. For example, the following values are not allowed:

  • *.mark-done
  • *.auto
Returns Array.<Section>

Type definitions

The Configuration namespace includes the following object types:

Section

Description Represents the JSON structure of a configuration section. Each section includes a list of key/value pairs for the matching option(s).
Type Object
Properties
Name Type Description
name string The name of the configuration option.
value string or array of strings The value of the configuration option.
This page was last edited on July 20, 2021, at 14:19.
Comments or questions about this documentation? Contact us for support!