Package com.inductiveautomation.perspective.common.api

Class ComponentEventDescriptor

java.lang.Object

com.inductiveautomation.perspective.common.api.ComponentEventDescriptor

public class ComponentEventDescriptor
extends java.lang.Object

Describes an event that a component might fire.

Constructor Summary

Constructors

Constructor	Description
ComponentEventDescriptor(java.lang.String name)
ComponentEventDescriptor(java.lang.String name, JsonSchema schema)
ComponentEventDescriptor(java.lang.String name, java.lang.String description, JsonSchema schema)
ComponentEventDescriptor(java.lang.String name, java.lang.String description, JsonSchema schema, java.lang.String documentationUrl)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()
java.lang.String	getDocumentationUrl()	A URL to read further information about this event, e.g.
java.lang.String	getName()	The name of the event, like "onThingHappened"
JsonSchema	getSchema()	The schema for the event object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentEventDescriptor

public ComponentEventDescriptor(java.lang.String name)

ComponentEventDescriptor

public ComponentEventDescriptor(java.lang.String name,
                                JsonSchema schema)

ComponentEventDescriptor

public ComponentEventDescriptor(java.lang.String name,
                                java.lang.String description,
                                JsonSchema schema)

ComponentEventDescriptor

public ComponentEventDescriptor(java.lang.String name,
                                java.lang.String description,
                                JsonSchema schema,
                                java.lang.String documentationUrl)

Method Detail

getName

public java.lang.String getName()

The name of the event, like "onThingHappened"

getDescription

public java.lang.String getDescription()

getDocumentationUrl

public java.lang.String getDocumentationUrl()

A URL to read further information about this event, e.g. to a user manual page.

getSchema

public JsonSchema getSchema()

The schema for the event object. Default implementation returns an empty schema.