Velocity API: WLEvent.off()

Version 1

    Return To Index

    WLEvent.off()

    Overview

    Remove an event handler for the current or specified scope.

    Format

     

    WLEvent.off(eventName, funcRef, scope);
    ParameterDescriptionTypeRequiredNotes
    eventNameThe name of the event.StringRequired
    funcRefThe function that was registered and should be removed.FunctionOptionalIf no value is provided, then all handlers for the event are removed.
    scopeThe scope the event is removed from.StringOptionalIf no value is provided, the current scope is used.

     

    Example

    /* The session scan event for myFunction is removed from the 
    * event handlers.
    */
      
    WLEvent.off("Scan", myFunction, "session");