Interface: PluginStatic<P>

@appium/types.PluginStatic

The interface describing the constructor and static properties of a Plugin.

Type parameters

Name	Type
P	extends Plugin

Table of contents

Properties

• executeMethodMap
• newMethodMap
• updateServer

Properties

executeMethodMap

• Optional executeMethodMap: ExecuteMethodMap<P>

Defined in

node_modules/@appium/types/lib/plugin.ts:28

---

newMethodMap

• Optional newMethodMap: MethodMap<P>

Plugins can define new methods for the Appium server to map to command names, of the same format as used in Appium's routes.js, for example, this would be a valid newMethodMap:

Example

{
   *   '/session/:sessionId/new_method': {
   *     GET: {command: 'getNewThing'},
   *     POST: {command: 'setNewThing', payloadParams: {required: ['someParam']}}
   *   }
   * }

Defined in

node_modules/@appium/types/lib/plugin.ts:27

---

updateServer

• Optional updateServer: UpdateServerCallback

Allows a plugin to modify the Appium server instance.

Defined in

node_modules/@appium/types/lib/plugin.ts:15