GetPlugins

Will retrieve a list of plugins for the product.

Syntax

Method ID

#define WAAPI_MID_COMMON_GET_PLUGINS 2000

JSON Input Structure

{
  "input": {
    "method": 2000,
    "signature": number,
    "default_language": string
  }
}

Input Properties

Parameter	Type	Description
`default_language`	string	(optional) The language used for the name and description of the plugin, currently supported: "en". If this field is not set or the plugin does not support this language, the language of the active profile will be used.

JSON Output Structure

{
  "result": {
    "method": 2000,
    "code": number,
    "timing": number,
    "timestamp": string,
    "plugins": [
      {
        "id": string,
        "name": string,
        "version": string,
        "type": string,
        "details": object
      },
      ...
    ]
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.plugins`	array<object>	An array of plugin objects detected for the product.
`result.plugins.id`	string	(optional) A unique identifier for the plugin.
`result.plugins.name`	string	The name of the plugin.
`result.plugins.version`	string	The version for the plugin.
`result.plugins.type`	string	The type of plugin. This will generally be 'extension' or 'toolbar', but other types may be added.
`result.plugins.details`	object	(optional) An object with additional details related to the plugin. This information will vary on a per product basis.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​