#include <adhoc.h>
|
| Command (const std::string &node, const std::string &sessionid, Action action, AdhocPlugin *plugin=0) |
|
| Command (const std::string &node, const std::string &sessionid, Status status, AdhocPlugin *plugin=0) |
|
| Command (const std::string &node, const std::string &sessionid, Status status, Action executeAction, int allowedActions=Complete, AdhocPlugin *plugin=0) |
|
| Command (const std::string &node, Action action, AdhocPlugin *plugin=0) |
|
| Command (const Tag *tag=0) |
|
virtual | ~Command () |
|
const std::string & | node () const |
|
const std::string & | sessionID () const |
|
Status | status () const |
|
Action | action () const |
|
int | actions () const |
|
const NoteList & | notes () const |
|
void | addNote (const Note *note) |
|
GLOOX_DEPRECATED const AdhocPlugin * | form () const |
|
const AdhocPlugin * | plugin () const |
|
virtual const std::string & | filterString () const |
|
virtual StanzaExtension * | newInstance (const Tag *tag) const |
|
virtual Tag * | tag () const |
|
virtual StanzaExtension * | clone () const |
|
| StanzaExtension (int type) |
|
virtual | ~StanzaExtension () |
|
virtual Stanza * | embeddedStanza () const |
|
virtual Tag * | embeddedTag () const |
|
int | extensionType () const |
|
An abstraction of an Adhoc Command element (from Adhoc Commands, XEP-0050) as a StanzaExtension.
- Author
- Jakob Schröter js@ca.nosp@m.maya.nosp@m..net
- Since
- 1.0
Definition at line 91 of file adhoc.h.
◆ NoteList
A list of command notes.
Definition at line 198 of file adhoc.h.
◆ Action
Specifies the action to undertake with the given command.
Enumerator |
---|
Execute | The command should be executed or continue to be executed. This is the default value.
|
Cancel | The command should be canceled.
|
Previous | The command should be digress to the previous stage of execution.
|
Next | The command should progress to the next stage of execution.
|
Complete | The command should be completed (if possible).
|
InvalidAction | The action is unknown or invalid.
|
Definition at line 100 of file adhoc.h.
◆ Status
Describes the current status of a command.
Enumerator |
---|
Executing | The command is being executed.
|
Completed | The command has completed. The command session has ended.
|
Canceled | The command has been canceled. The command session has ended.
|
InvalidStatus | The status is unknown or invalid.
|
Definition at line 116 of file adhoc.h.
◆ Command() [1/5]
Creates a Command object that can be used to perform the provided Action. This constructor is used best to continue execution of a multi stage command (for which the session ID must be known).
- Parameters
-
node | The node (command) to perform the action on. |
sessionid | The session ID of an already running adhoc command session. |
action | The action to perform. |
plugin | An optional AdhocPlugin (e.g. DataForm) to include in the request. Will be deleted in Command's destructor. |
Definition at line 97 of file adhoc.cpp.
◆ Command() [2/5]
Creates a Command object that can be used to perform the provided Action. This constructor is used best to reply to an execute request.
- Parameters
-
node | The node (command) to perform the action on. |
sessionid | The (possibly newly created) session ID of the adhoc command session. |
status | The execution status. |
plugin | An optional AdhocPlugin (e.g. DataForm) to include in the reply. Will be deleted in Command's destructor. |
Definition at line 90 of file adhoc.cpp.
◆ Command() [3/5]
Creates a Command object that can be used to perform the provided Action. This constructor is used best to reply to a multi stage command that is not yet completed (for which the session ID must be known).
- Parameters
-
node | The node (command) to perform the action on. |
sessionid | The (possibly newly created) session ID of the adhoc command session. |
status | The execution status. |
executeAction | The action to execute. |
allowedActions | Allowed reply actions. |
plugin | An optional AdhocPlugin (e.g. DataForm) to include in the reply. Will be deleted in Command's destructor. |
Definition at line 105 of file adhoc.cpp.
◆ Command() [4/5]
Creates a Command object that can be used to perform the provided Action. This constructor is used best to execute the initial step of a command (single or multi stage).
- Parameters
-
node | The node (command) to perform the action on. |
action | The action to perform. |
plugin | An optional AdhocPlugin (e.g. DataForm) to include in the request. Will be deleted in Command's destructor. |
Definition at line 83 of file adhoc.cpp.
◆ Command() [5/5]
Creates a Command object from the given Tag.
- Parameters
-
tag | A <command> tag in the adhoc commands' namespace. |
Definition at line 113 of file adhoc.cpp.
◆ ~Command()
Virtual destructor.
Definition at line 156 of file adhoc.cpp.
◆ action()
Returns the command's action.
- Returns
- The command's action.
Definition at line 287 of file adhoc.h.
◆ actions()
Returns the ORed actions that are allowed to be executed on the current stage.
- Returns
- An int containing the ORed actions.
Definition at line 294 of file adhoc.h.
◆ addNote()
void addNote |
( |
const Note * |
note | ) |
|
|
inline |
Use this function to add a note to the command.
- Parameters
-
Definition at line 307 of file adhoc.h.
◆ clone()
◆ filterString()
const std::string & filterString |
( |
| ) |
const |
|
virtual |
Returns an XPath expression that describes a path to child elements of a stanza that an extension handles.
- Returns
- The extension's filter string.
Implements StanzaExtension.
Definition at line 162 of file adhoc.cpp.
◆ form()
◆ newInstance()
Returns a new Instance of the derived type. Usually, for a derived class FooExtension, the implementation of this function looks like:
{
return new FooExtension(
tag );
}
virtual Tag * tag() const
StanzaExtension(int type)
- Returns
- The derived extension's new instance.
Implements StanzaExtension.
Definition at line 326 of file adhoc.h.
◆ node()
const std::string& node |
( |
| ) |
const |
|
inline |
Returns the node identifier (the command).
- Returns
- The node identifier.
Definition at line 268 of file adhoc.h.
◆ notes()
Returns the list of notes associated with the command.
- Returns
- The list of notes.
Definition at line 300 of file adhoc.h.
◆ plugin()
◆ sessionID()
const std::string& sessionID |
( |
| ) |
const |
|
inline |
Returns the command's session ID, if any.
- Returns
- The command's session ID.
Definition at line 274 of file adhoc.h.
◆ status()
Returns the execution status for a command. Only valid for execution results.
- Returns
- The execution status for a command.
Definition at line 281 of file adhoc.h.
◆ tag()
The documentation for this class was generated from the following files: