request.stack.add

(since )



Add a command to request stack

Description


string request.stack.add ( mixed cmd, [string params], [object options] )

APE JSF allows you to create "stacks" of request.

These methods are very useful for example if your application must send different commands to APE server from several functions and you want to send them all at once.

Parameters


cmd
If the argument is a string :
  • Command to send to APE server (eg : 'CONNECT') - ()
If the argument is an array :
  • An array with object containing cmd, params and sessid - ()

params
And object with params of the cmd

options
An object with request options :
  • sessid - (boolean, optional) ; defaults to : true Add sessid to the request.

Examples


//ape var is a reference to APE instance
 
//Add two request to the stack
ape.request.stack.add('testCommand', {"param1":"value"});
ape.request.stack.add('anotherCommand', {"param1":"value"});
 
//Send the stack to APE server
ape.request.stack.send();
 

User notes


# No comment

Post a note


User notes may be edited or deleted, and usually a note is deleted because of the following reasons:
  • Bugs: Instead report a bug
  • Missing documentation: report that as a bug.
  • Support questions: See the community for available options.

In other words, do not ask questions within the user notes.

Note <b>,<u>,<i> HTML tags are allowed in the posts and the note formatting is preserved. URLs will be turned into clickable links, JavaScipt and C code blocks enclosed in the <source="javascript">JS Code</source> and <source="c">C Code</source> tags will be source highlighted automatically.