Purpose
Use this function to get information about plugin configuration.
Mandatory
Yes
Input Parameters
None
Response
An associative array that contains the following keys:
| Parameter name | Description | Type |
|---|---|---|
friendlyName
|
A user friendly plugin name. It will be displayed in UX1. | string
|
parameters
|
An associative array that contains arrays with parameters for each configuration parameter. | array[Parameter] |
Parameter
An associative array that contains the following keys:
| Parameter name | Available values | Description | Type |
|---|---|---|---|
name
|
|
Parameter name. | string
|
friendlyName
|
|
A user friendly name of parameter. It is used on plug-in configuration screen in UX1. | string
|
type
|
text, password |
Parameter type. | string
|
size
|
|
Maximum length (in characters) of the parameter value. | number
|
required
|
true, false |
Indicates whether this parameter is required or not. | boolean
|
Example
Copy
function Example_GetConfig()
{
return array(
'friendlyName' => 'Example Plug-In',
'parameters' => array(
array(
'name' => 'username',
'friendlyName' => 'Username or Email Address',
'type' => 'text',
'size' => 40,
'required' => true),
array(
'name' => 'password',
'friendlyName' => 'Password',
'type' => 'password',
'size' => 40,
'required' => true),
array(
'name' => 'company',
'friendlyName' => 'Company',
'type' => 'text',
'size' => 100,
'required' => false)
);
}