The actions module

The actions module contains classes pertaining to creating objects which can be sent to the iPhone or Apple’s web server which pertain to specific actions.

The Commands class

class pysiriproxy.objects.actions.Commands

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)

Create a Command of the specific type.

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

The _CustomCommand class

class pysiriproxy.objects.actions._CustomCommand(command)

The _CustomCommand class creates a StartRequest object which contains a custom command.

The SiriObject class

class pysiriproxy.objects.actions.SiriObject(className, group)

The SiriObject class encapsulates the base functionality for all object being sent to the iPhone or to Apple’s web server.

Note

This class is meant to be subclassed to provide the implementation for a specific object.

ProtocolVersion

The identifier which indicates the version of the protocol.

classmethod isArgumentList(obj)

Determine if the given object is a list of arguments, or not.

• obj – The object

classmethod isSiriObject(obj)

Determine if the given object is a SiriObject, or not.

• obj – The object

makeRoot(refId=None, aceId=None)

Make the SiriObject the root object.

• refId – The refId for this object
• aceId – The aceId for this object

setAceId(aceId=None)

Set the ace id for this object.

• aceId – The aceId for this object

setNonNoneArguments(argumentNames, localVars)

Takes a list of strings which represent names of input variables and sets properties of the same name on the current object if the value of the argument is not None.

• argumentNames – The list of argument names to set
• localVars – The local variables

setRefId(refId=None)

Set the ref id for this object.

• refId – The refId for this object

toDict()

Convert this object into a Python dictionary.

The _WebSearch class

class pysiriproxy.objects.actions._WebSearch(query)

The _WebSearch class creates a command to perform a web search for a particular search phrase.

The Actions class

class pysiriproxy.objects.actions.Actions

The Actions class contains a list of Action types as well as a function for creating specific types of Actions.

This class provides a factory function for creating Actions of a specific type.

CustomCommand

The CustomCommand action type.

WebSearch

The WebSearch action type.

classmethod create(actionType, *args, **kwargs)

Return a specific Action wrapped in a SendCommands object so it can be sent to Siri as a command.

• actionType – The type of Action to create
• args – The arguments
• kwargs – The keyword arguments