Difference between revisions of "UI Script Handlers"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the UI Script Handlers class)
 
(Documentation for the UI Script Handlers class)
Line 1: Line 1:
== UI Script Handlers ==
+
==UI Script Handlers==
=== IJavaScriptCallbackContext ===
+
===IJavaScriptCallbackContext===
:* See Also: [[IJavaScriptCallbackContext]]
+
:* Full Article: [[IJavaScriptCallbackContext]]
:
+
When a message is received from a connected client UI script, this context is passed to your handler's Callback method if the reflection based proxy system isn't able to automatically map the message to one of your handler methods. It represents a deserialized JSON message with the properties of the root object exposed as a collection.
:When a message is received from a connected client UI script, this context is passed to your handler's Callback method if the reflection based proxy system isn't able to automatically map the message to one of your handler methods. It represents a deserialized JSON message with the properties of the root object exposed as a collection.
+
  
=== IUIScript ===
+
===IUIScript===
:* See Also: [[IUIScript]]
+
:* Full Article: [[IUIScript]]
:
+
All Component UI Script handlers must implement this interface, provide a constructor that takes an [[IUIScriptHandle]], and should have a [[UIScriptHandlerAttribute]] applied
:All Component UI Script handlers must implement this interface, provide a constructor that takes an [[IUIScriptHandle]], and should have a [[UIScriptHandlerAttribute]] applied
+
  
=== IUIScriptHandle ===
+
===IUIScriptHandle===
:* See Also: [[IUIScriptHandle]]
+
:* Full Article: [[IUIScriptHandle]]
:
+
Represents a Layer One UI script handle.
:Represents a Layer One UI script handle.
+
  
=== ScriptHandler ===
+
===ScriptHandler===
:* See Also: [[ScriptHandler]]
+
:* Full Article: [[ScriptHandler]]
:
+
Provides a default implementation of [[IUIScript]] which you can derive from
:Provides a default implementation of [[IUIScript]] which you can derive from
+
  
=== UIScriptHandlerAttribute ===
+
===UIScriptHandlerAttribute===
:* See Also: [[UIScriptHandlerAttribute]]
+
:* Full Article: [[UIScriptHandlerAttribute]]
:
+
Marks a class as a UI Script Handler
:Marks a class as a UI Script Handler
+
 
 +
===WorkflowUIScriptHandler===
 +
:* Full Article: [[WorkflowUIScriptHandler]]

Revision as of 16:35, 21 October 2016

UI Script Handlers

IJavaScriptCallbackContext

When a message is received from a connected client UI script, this context is passed to your handler's Callback method if the reflection based proxy system isn't able to automatically map the message to one of your handler methods. It represents a deserialized JSON message with the properties of the root object exposed as a collection.

IUIScript

All Component UI Script handlers must implement this interface, provide a constructor that takes an IUIScriptHandle, and should have a UIScriptHandlerAttribute applied

IUIScriptHandle

Represents a Layer One UI script handle.

ScriptHandler

Provides a default implementation of IUIScript which you can derive from

UIScriptHandlerAttribute

Marks a class as a UI Script Handler

WorkflowUIScriptHandler