The commands module

The commands module contains classes pertaining to creating objects which can be sent to the iPhone or the Guzzoni web server which pertain to creating commands which are sent from the iPhone to the Guzzoni web server.

The _SendCommands class

Inheritance diagram of pysiriproxy.objects.commands._SendCommands

class pysiriproxy.objects.commands._SendCommands(commands=None)[source]

The _SendCommands class creates an object that is able to send a series of commands from the iPhone to the Guzzoni web server which are to be executed.

The _ConfirmationOptions class

Inheritance diagram of pysiriproxy.objects.commands._ConfirmationOptions

class pysiriproxy.objects.commands._ConfirmationOptions(submitCmds=None, cancelCmds=None, denyCmds=None, confirmCmds=None, denyText='Cancel', cancelLabel='Cancel', submitLabel='Send', confirmText='Send', cancelTrigger='Deny')[source]

The _ConfirmationOptions class provides the ability to create a dialog that presents the user with confirmation options such as: submit, and cancel buttons that each perform different actions.

The _ConfirmSnippetCommand class

Inheritance diagram of pysiriproxy.objects.commands._ConfirmSnippetCommand

class pysiriproxy.objects.commands._ConfirmSnippetCommand(requestId='')[source]

The _ConfirmSnippetCommand class creates a confirmation command.

The _CancelSnippetCommand class

Inheritance diagram of pysiriproxy.objects.commands._CancelSnippetCommand

class pysiriproxy.objects.commands._CancelSnippetCommand(requestId='')[source]

The _CancelSnippetCommand class creates a cancel command.

The _CancelRequest class

Inheritance diagram of pysiriproxy.objects.commands._CancelRequest

class pysiriproxy.objects.commands._CancelRequest(requestId)[source]

The _CancelRequest class creates an object to cancel the current request.

The _ResultCallback class

Inheritance diagram of pysiriproxy.objects.commands._ResultCallback

class pysiriproxy.objects.commands._ResultCallback(commands)[source]

The _ResultCallback class creates a result callback Siri object.

The Commands class

Inheritance diagram of pysiriproxy.objects.commands.Commands

class pysiriproxy.objects.commands.Commands[source]

The Commands class contains the various types of Commands as well as a function for creating Commands of a specific type.

This class provides a factory method for creating Commands of a specific type.

CancelRequest

The CancelRequest command type.

CancelSnippet

The CancelSnippet command type.

ConfirmSnippet

The ConfirmSnippet command type.

ConfirmationOptions

The ConfirmationOptions command type.

ResultCallback

The ResultCallback command type.

SendCommands

The SendCommands command type.

classmethod create(commandType, *args, **kwargs)[source]

Create a Command of the specific type.

  • commandType – The type of Command to create
  • args – The arguments
  • kwargs – THe keyword arguments