Skip to main content

An object describing an Interop method registered by an application.

Properties (9)

Property Type Default Required Description
accepts⚓︎ string x x

Signature describing the parameters that the method expects.

description⚓︎ string x x

Description of what the method does. Useful for documentation purposes and for UI clients.

displayName⚓︎ string x x

The actual name of the method, used in UI applications.

flags⚓︎ { [key: string]: any } x x

Optional flags attached to the method

name⚓︎ string x

The name of the method. Must be unique.

objectTypes⚓︎ string[] x x

The entities this method is meant to work with.

returns⚓︎ string x x

Signature describing the properties of the object the method returns.

supportsStreaming⚓︎ boolean x x

If true, the method is a stream.

version⚓︎ number x x

Method version.

1 Methods

getServers()⚓︎

() => Instance[]

Returns all servers that provide the method.