Class Index | File Index

Classes


Class BoxCallbacks

BOX Callbacks plugs into a Component Space so it can make network calls.
Defined in: boxcs.js.

Class Summary
Constructor Attributes Constructor Name and Description
<private> <inner>  
Method Summary
Method Attributes Method Name and Description
<private>  
add(comp, slotName, val, flags, facets, cb)
Server Add.
<private>  
fire(comp, slot, event, cb)
Server Topic Fire.
<private>  
getActionParameterDefault(comp, action, cb)
Get the Action Parameter Default Value.
<private>  
getNavChildren(handle, cb)
Get the Nav Children of a Component.
<private>  
getService(typeSpec, cb)
Resolve a Service via its TypeSpec (moduleName:typeName).
<private>  
handleToPath(handle, cb)
Convert a handle to a Slot Path.
<private>  
invokeAction(comp, the, val, cb)
Invoke an Action.
<private>  
loadSlotPath(slotPathInfo, container, cb, importAsync)
Load Slot Path.
<private>  
loadSlots(ord, depth, cb)
Load Slots.
<private>  
makeLink(source, sourceSlot, target, targetSlot, cb)
Make a Link.
<private>  
poll(cb)
Poll the Server for events.
<private>  
remove(comp, slot, cb)
Server Remove.
<private>  
rename(comp, oldName, newName, cb)
Server Rename.
<private>  
reorder(comp, dynamicProperties, cb)
Server Reorder.
<private>  
serverSideCall(comp, typeSpec, methodName, val, cb)
Invoke a Server Side Call.
<private>  
serviceToPath(typeSpec, cb)
Resolve a Service to its SlotPath via a TypeSpec.
<private>  
set(comp, propPath, val, cb)
Server Set.
<private>  
setFacets(comp, slot, facets, cb)
Server Set Facets.
<private>  
setFlags(comp, slot, flags, cb)
Server Set Flags.
<private>  
subscribe(ords, importAsync, cb)
Component Subscription.
<private>  
unsubscribe(ords, cb)
Component Unsubscription.
Class Detail
<private> <inner> BoxCallbacks()
Method Detail
<private> add(comp, slotName, val, flags, facets, cb)
Server Add.
Parameters:
comp
the Component being added too.
{String} slotName
val
the value to be added.
{Number} flags
slot flags.
{baja.Facets} facets
slot facets.
{baja.comm.Callback} cb

<private> fire(comp, slot, event, cb)
Server Topic Fire.
Parameters:
comp
the Component the Topic will be fired from.
{baja.Slot} slot
the Topic Slot.
event
the Topic event (can be null).
{baja.comm.Callback} cb

<private> getActionParameterDefault(comp, action, cb)
Get the Action Parameter Default Value.
Parameters:
{baja.Component} comp
{baja.Action} action
{baja.comm.Callback} cb

<private> getNavChildren(handle, cb)
Get the Nav Children of a Component.
Parameters:
{String} handle
{baja.comm.Callback} cb

<private> getService(typeSpec, cb)
Resolve a Service via its TypeSpec (moduleName:typeName).
Parameters:
{String} typeSpec
{baja.comm.Callback} cb

<private> handleToPath(handle, cb)
Convert a handle to a Slot Path.
Parameters:
{String} handle
{baja.comm.Callback} cb

<private> invokeAction(comp, the, val, cb)
Invoke an Action.
Parameters:
comp
the Component the Action will be invoked upon.
{baja.Slot} the
Action Slot.
val
the argument for the Action (can be null).
{baja.comm.Callback} cb

<private> loadSlotPath(slotPathInfo, container, cb, importAsync)
Load Slot Path.
Parameters:
{Array} slotPathInfo
container
{baja.comm.Callback} cb
{Boolean} importAsync Optional
import any extra types asynchronously (true by default).

<private> loadSlots(ord, depth, cb)
Load Slots.
Parameters:
{String} ord
{Number} depth
{baja.comm.Callback} cb

<private> makeLink(source, sourceSlot, target, targetSlot, cb)
Make a Link.
Parameters:
{baja.Component} source
Component for the link.
{baja.Slot} sourceSlot
source Slot for the link.
{baja.Component} target
Component for the link.
{baja.Slot} targetSlot
target Slot for the link.
{baja.comm.Callback} cb

<private> poll(cb)
Poll the Server for events.
Parameters:
{baja.comm.Callback} cb

<private> remove(comp, slot, cb)
Server Remove.
Parameters:
comp
the Component being removed from.
{baja.Slot} slot
the slot to be removed.
{baja.comm.Callback} cb

<private> rename(comp, oldName, newName, cb)
Server Rename.
Parameters:
comp
the Component the slot is being renamed on.
{String} oldName
the old name of the slot.
{String} newName
the new name of the slot.
{baja.comm.Callback} cb

<private> reorder(comp, dynamicProperties, cb)
Server Reorder.
Parameters:
comp
the Component the dynamic slots are being reordered upon.
{Array} dynamicProperties
an array of Property names that specify the new order.
{baja.comm.Callback} cb

<private> serverSideCall(comp, typeSpec, methodName, val, cb)
Invoke a Server Side Call.
Parameters:
comp
the Component for the Server Side Call.
{String} typeSpec
{String} methodName
val
the argument for the Server Side Call (can be null).
{baja.comm.Callback} cb

<private> serviceToPath(typeSpec, cb)
Resolve a Service to its SlotPath via a TypeSpec.
Parameters:
{String} typeSpec
{baja.comm.Callback} cb

<private> set(comp, propPath, val, cb)
Server Set.
Parameters:
comp
the Component being added too.
{Array} propPath
array of Property names used for the set.
val
the value for the set.
{baja.comm.Callback} cb

<private> setFacets(comp, slot, facets, cb)
Server Set Facets.
Parameters:
comp
the Component for the slot the facets will be set upon.
{baja.Slot} slot
the dynamic slot the facets are being set upon.
{baja.Facets} facets
the new slot facets.
{baja.comm.Callback} cb

<private> setFlags(comp, slot, flags, cb)
Server Set Flags.
Parameters:
comp
the Component for the slot the flags will be set upon.
{baja.Slot} slot
the slot the flags are being set upon.
{Number} flags
the new slot flags.
{baja.comm.Callback} cb

<private> subscribe(ords, importAsync, cb)
Component Subscription.
Parameters:
{Array} ords
an array of ORDs to Components.
{Boolean} importAsync Optional
make any Type and Contract imports asynchronous (false by default).
{baja.comm.Callback} cb

<private> unsubscribe(ords, cb)
Component Unsubscription.
Parameters:
{Array} ords
an array of Components to unsubscribe.
{baja.comm.Callback} cb

Documentation generated by JsDoc Toolkit 2.3.2