The views module

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

The _ShowMapPoints class

class pysiriproxy.objects.views._ShowMapPoints(showDirections=True, showTraffic=False, directionsType='ByCar', callbacks=None, source=None, destination=None)

The _ShowMapPoints class creates a series of map poitns to be displayed to the iPhone user.

The _MapItemSnippet class

class pysiriproxy.objects.views._MapItemSnippet(useCurrentLocation=True, items=None)

The _MapItemSnippet class creates a map item snippet to be displayed to the iPhone user.

The Views class

class pysiriproxy.objects.views.Views

Contains the various types of Views as well as a function for creating Views of a specific type.

This class also contains a factory method for creating views of a specific type.

AddViews

The AddViews object type.

AnswerSnippet

The AnswerSnippet object type.

MapItemSnippet

The MapItemSnippet object type.

MapPoints

The ShowMapPoints object type.

Utterance

The Utterance object type.

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

Create a View of the given type.

• viewType – The type of View to create
• args – The arguments
• kwargs – The keyword arguments to create

The _AnswerSnippet class

class pysiriproxy.objects.views._AnswerSnippet(answers=None, confirmationOptions=None)

The _AnswerSnipper class creates an answer snippet to be displayed to the iPhone user.

The SiriObject class

class pysiriproxy.objects.views.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 _Utterance class

class pysiriproxy.objects.views._Utterance(displayText='', spokenText=None, listenAfterSpeaking=False, dialogIdentifier='Misc#ident')

The _Utterance class creates an object that can display a given piece of text and have Siri speak another given piece of text (or the same piece of text).

The _AddViews class

class pysiriproxy.objects.views._AddViews(scrollToTop=False, temporary=False, dialogPhase='Completion', views=None, callbacks=None)

The _AddViews class creates an object that can create a series of views to be displayed on the iPhone.