Velocity API: WLEvent.unregisterScope

Version 2

    Return To Index

    WLEvent.unregisterScope

    Overview

    Remove the function from the specified scope.

    Format

     

    WLEvent.unregisterScope(scope, reference);
    ParameterDescriptionTypeRequiredNotes
    scopeThe type of the scope that the specified function is removed from. Valid values:
    'global' - Applies the event to all scopes.
    'session' - Applies the event to a single session.
    StringOptionalIf no value is provided, the current scope is used.

     

    Example

    /* The onError function is removed from the 
    " session" scope.
    */
      
    WLEvent.unregisterScope("session", onErrorReference);