Reference > AmiScript API > Classes

SubscribeProcessor¶

Definition¶

1	`SubscribeProcessor var = .... ;`

Extends¶

Extended By¶

None

Description¶

An ami center subscription realtime processor.

Method Summary¶

Owner	Name	Return Type	Description
DashboardResource	commit()	Object	Commits transient changes, promoting overrides to persisted values. If transient, makes permanent.
DashboardResource	getCallback(callbackName)	Callback	Returns a callback by name
DashboardResource	getCallbackNames()	List	Returns the callback names defined for this dashboard resource. Use session.getDevTools().getCallbackEditor(resource, callbackName) to edit one, and call editor.open() when you want to show the UI.
DashboardResource	getCallbacks()	Map	Returns a map of all callback definitions.
DashboardResource	getChildren()	List	Returns a list of the child dashboard resources.
Object	getClassName()	String	Returns the string name of this object's class type.
SubscribeProcessor	getColumns()	List	Returns the subscribed column names, or null if all columns are subscribed.
DashboardResource	getDRI()	String	Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of an object within the entire dashboard.
DashboardResource	getDashboardResourceType()	String	Returns the Dashboard Resource Type as a string
DashboardResource	getFormula(formulaName)	Formula	Returns a Formula given the formula name.
DashboardResource	getFormulaNames()	Set	Returns a set of the names of all formulas for this object.
DashboardResource	getFormulas()	Map	Returns a map of all available formulas for this object. The key is the formula name.
Processor	getId()	String	Returns the user-assigned ID for this relationship.
DashboardResource	getLRI()	String	Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
Processor	getLayout()	Layout	Returns the layout that owns this relationship.
DashboardResource	getOwner()	DashboardResource	Returns the DashboardResource that owns this object.
SubscribeProcessor	getWhere()	String	Returns the where-clause filter for the subscription.
DashboardResource	invokeCallback(callbackName, args)	Object	Executes the specified callback definition and returns the result from the callback.
SubscribeProcessor	isConnected()	Boolean	Returns true if the subscription's upstream center connection is currently established, false otherwise.
DashboardResource	isTransient()	Boolean	Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.
SubscribeProcessor	setColumns(columns)	SubscribeProcessor	Sets the subscribed column names. Call rebuild() to apply.
SubscribeProcessor	setWhere(where)	SubscribeProcessor	Sets the where-clause filter for the subscription. Call rebuild() to apply.
Object	toJson()	String	Returns a string of a json representation of this object.
Processor	toTable()	Table	Returns the underlying table that this processor is handling.

Method Definitions¶

commit()¶

Object DashboardResource::commit()

Description¶

Commits transient changes, promoting overrides to persisted values. If transient, makes permanent.

getCallback(callbackName)¶

Callback DashboardResource::getCallback(String callbackName)

Description¶

Returns a callback by name

Parameter Definition¶

Name	Type	Description
callbackName	String	method name of callback

getCallbackNames()¶

List DashboardResource::getCallbackNames()

Description¶

Returns the callback names defined for this dashboard resource. Use session.getDevTools().getCallbackEditor(resource, callbackName) to edit one, and call editor.open() when you want to show the UI.