Zimlet JavaScript API Reference - ZmClientCmdHandler

Class ZmClientCmdHandler


This class represents a client command handler.

Defined in: ZmClientCmdHandler.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates the client.
Method Summary
Method Attributes Method Name and Description
 
execute(cmdStr, searchController, cmdArg1)
Executes the command.
 
execute_alert(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the alert command.
 
execute_clearAutocompleteCache(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the clearAutocompleteCache command.
 
execute_compose(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the compose command.
 
execute_debug(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the command with debug.
 
execute_debugtrace(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the command with debug trace.
 
execute_error(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the error command.
 
execute_expire(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the expire command.
 
execute_get(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the get version/release/date command.
 
execute_getCharWidth(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the getCharWidth command.
 
execute_instant_notify(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the instant notify "ON" command.
 
execute_leak(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the leak detector command.
 
execute_log(cmdStr, searchController, cmdArg1, cmdArg1, cmdArg2)
Executes the log command.
 
execute_modify(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the modify command.
 
execute_noop(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the no op command.
 
execute_poll(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the poll interval command.
 
execute_refresh(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the refresh command.
 
execute_relogin(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the re-login command.
 
execute_rh(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the reminder housekeeping command.
 
execute_rr(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the reminder refresh command.
 
execute_tabs(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the tabs command.
 
execute_toast(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the toast command.
 
execute_ymid(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the Yahoo! IM command.
Class Detail
ZmClientCmdHandler()
Creates the client. command handler
Method Detail
execute(cmdStr, searchController, cmdArg1)
Executes the command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments

execute_alert(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the alert command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
{Object} cmdArg2 Optional
command arguments
cmdArg2

execute_clearAutocompleteCache(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the clearAutocompleteCache command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
{Object} cmdArg2 Optional
command arguments
cmdArg2

execute_compose(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the compose command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_debug(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the command with debug.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_debugtrace(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the command with debug trace.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_error(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the error command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
{Object} cmdArg2 Optional
command arguments
cmdArg2

execute_expire(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the expire command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_get(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the get version/release/date command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_getCharWidth(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the getCharWidth command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
{Object} cmdArg2 Optional
command arguments
cmdArg2

execute_instant_notify(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the instant notify "ON" command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_leak(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the leak detector command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_log(cmdStr, searchController, cmdArg1, cmdArg1, cmdArg2)
Executes the log command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1
cmdArg2

execute_modify(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the modify command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
{Object} cmdArg2 Optional
command arguments
cmdArg2

execute_noop(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the no op command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_poll(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the poll interval command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_refresh(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the refresh command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_relogin(cmdStr, searchController, cmdArg1, cmdArg2, cmdArg2)
Executes the re-login command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
{Object} cmdArg2 Optional
command arguments
cmdArg2

execute_rh(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the reminder housekeeping command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_rr(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the reminder refresh command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_tabs(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the tabs command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_toast(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the toast command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

execute_ymid(cmdStr, searchController, cmdArg1, cmdArg1)
Executes the Yahoo! IM command.
Parameters:
{String} cmdStr
the command
{ZmSearchController} searchController
the search controller
{Object} cmdArg1 Optional
command arguments
cmdArg1

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:35 GMT-0400 (EDT)