unsubscribe( ) method (JSDO class)
- Last Updated: April 19, 2017
- 2 minute read
- OpenEdge
- Version 13.0
- Documentation
Unsubscribes a given event callback function from a named event of the current JSDO or table reference.
For more information on these events, see the refernce entry for progress.data.JSDO class.
Return type: null
Applies to: progress.data.JSDO class, table reference property (JSDO class)
Syntax
|
- jsdo-ref
- A reference to the JSDO. If you call the method on jsdo-ref, you can unsubscribe the event handler from any event that fires on the JSDO and all its table references.
- table-ref
- A table reference on the JSDO. If you call the method on table-ref, you can unsubscribe the event handler from an event that fires only on the table reference.
- event-name
- The name of an event to which you unsubscribe an event handler. See the refernce entry for progress.data.JSDO class for a list of available JSDO events.
- op-name
- The name of a JSDO invocation method, a call to which causes the event
to fire. This parameter is required in cases where event-name is
beforeInvokeorafterInvoke. Use it only with these event names, and only when unsubscribing on the JSDO (not on a table-ref). To work, the op-name value must match the corresponding op-name parameter in a precedingsubscribe( )method call. - event-handler
- A reference to an event handler function that is called when the specified event fires.
- scope
- An optional object reference that defines the execution scope of the event handler
function called when the event fires. Specifying the scope is optional in the event
subscription. If the event subscription does specify an execution scope, you must
specify a matching scope parameter when you call the
unsubscribe( )method to cancel the event subscription.
See also:
invocation method, progress.data.JSDO class, subscribe( ) method (JSDO class), unsubscribeAll( ) method