Class UriHandlerPlugin

Plugin base class for handling URI requests within the Editor plugin system.

Hierarchy (View Summary)

IPlugin
- UriHandlerPlugin

Index

Constructors

Properties

id pluginSystem

Methods

getTypeName handle isOfType isSame

Constructors

constructor

new UriHandlerPlugin(
pluginSystem: PluginSystem,
descriptor?: Descriptor,
): UriHandlerPlugin
Constructs a UriHandlerPlugin instance with the given plugin system and optional descriptor.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns UriHandlerPlugin
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The PluginSystem instance this plugin is registered with.

Methods

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPlugin.getTypeName

handle

handle(uri: string): boolean
Handles a URI string and returns whether it was successfully processed.
Parameters
- uri: string
Returns boolean

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPlugin.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPlugin.isSame