googlevoice.voice.Voice Class Reference

List of all members.

Public Member Functions
def	__init__
def	call
def	cancel
def	contacts
def	download
def	login
def	logout
def	phones
def	search
def	send_sms
def	settings
def	special
	Some handy methods.
Properties
	contacts = property(contacts)
	phones = property(phones)
	settings = property(settings)
	special = property(special)
Private Member Functions
def	__do_page
	Helper methods.
def	__do_special_page
def	__get_xml_page
def	__messages_post
def	__validate_special_page
Private Attributes
	_contacts
	_special
Static Private Attributes
	__call__ = call
	_Message__messages_post = __messages_post
	_Phone__do_special_page = __do_special_page
	_Phone__validate_special_page = __validate_special_page

---

Detailed Description

Main voice instance for interacting with the Google Voice service
Handles login/logout and most of the baser HTTP methods

Definition at line 14 of file voice.py.

---

Constructor & Destructor Documentation

def googlevoice.voice.Voice.__init__

(

self

)

Definition at line 19 of file voice.py.

---

Member Function Documentation

def googlevoice.voice.Voice.__do_page	(		self,
			page,
			data = None,
			headers = {}
	)		[private]

Helper methods.

Loads a page out of the settings and pass it on to urllib Request

Definition at line 189 of file voice.py.

def googlevoice.voice.Voice.__do_special_page	(		self,
			page,
			data = None,
			headers = {}
	)		[private]

Add self.special to request data

Definition at line 214 of file voice.py.

def googlevoice.voice.Voice.__get_xml_page	(		self,
			page,
			data = None,
			headers = {}
	)		[private]

Return XMLParser instance generated from given page

Definition at line 227 of file voice.py.

def googlevoice.voice.Voice.__messages_post	(		self,
			page,
			msgs,
			kwargs
	)		[private]

Performs message operations, eg deleting,staring,moving

Definition at line 233 of file voice.py.

def googlevoice.voice.Voice.__validate_special_page	(		self,
			page,
			data = {},
			kwargs
	)		[private]

Validates a given special page for an 'ok' response

Definition at line 205 of file voice.py.

def googlevoice.voice.Voice.call	(		self,
			outgoingNumber,
			forwardingNumber = None,
			phoneType = None,
			subscriberNumber = None
	)

Make a call to an ``outgoingNumber`` from your ``forwardingNumber`` (optional).
If you pass in your ``forwardingNumber``, please also pass in the correct ``phoneType``

Definition at line 91 of file voice.py.

def googlevoice.voice.Voice.cancel	(		self,
			outgoingNumber = None,
			forwardingNumber = None
	)

Cancels a call matching outgoing and forwarding numbers (if given). 
Will raise an error if no matching call is being placed

Definition at line 111 of file voice.py.

def googlevoice.voice.Voice.contacts

(

self

)

Partial data of your Google Account Contacts related to your Voice account.
For a more comprehensive suite of APIs, check out http://code.google.com/apis/contacts/docs/1.0/developers_guide_python.html

Definition at line 173 of file voice.py.

def googlevoice.voice.Voice.download	(		self,
			msg,
			adir = None
	)

Download a voicemail or recorded call MP3 matching the given ``msg``
which can either be a ``Message`` instance, or a SHA1 identifier. 
Saves files to ``adir`` (defaults to current directory). 
Message hashes can be found in ``self.voicemail().messages`` for example. 
Returns location of saved file.

Definition at line 149 of file voice.py.

def googlevoice.voice.Voice.login	(		self,
			email = None,
			passwd = None
	)

Login to the service using your Google Voice account
Credentials will be propmpted for if not given as args or in the ``~/.gvoice`` config file

Definition at line 49 of file voice.py.

def googlevoice.voice.Voice.logout

(

self

)

Logs out an instance and makes sure it does not still have a session

Definition at line 82 of file voice.py.

def googlevoice.voice.Voice.phones

(

self

)

Returns a list of ``Phone`` instances attached to your account.

Definition at line 122 of file voice.py.

def googlevoice.voice.Voice.search	(		self,
			query
	)

Search your Google Voice Account history for calls, voicemails, and sms
Returns ``Folder`` instance containting matching messages

Definition at line 142 of file voice.py.

def googlevoice.voice.Voice.send_sms	(		self,
			phoneNumber,
			text
	)

Send an SMS message to a given ``phoneNumber`` with the given ``text`` message

Definition at line 136 of file voice.py.

def googlevoice.voice.Voice.settings

(

self

)

Dict of current Google Voice settings

Definition at line 129 of file voice.py.

def googlevoice.voice.Voice.special

(

self

)

Some handy methods.

Returns special identifier for your session (if logged in)

Definition at line 28 of file voice.py.

---

Member Data Documentation

googlevoice::voice.Voice::__call__ = call [static, private]

Definition at line 109 of file voice.py.

googlevoice::voice.Voice::_contacts [private]

Definition at line 176 of file voice.py.

googlevoice::voice.Voice::_Message__messages_post = __messages_post [static, private]

Definition at line 245 of file voice.py.

googlevoice::voice.Voice::_Phone__do_special_page = __do_special_page [static, private]

Definition at line 225 of file voice.py.

googlevoice::voice.Voice::_Phone__validate_special_page = __validate_special_page [static, private]

Definition at line 212 of file voice.py.

googlevoice::voice.Voice::_special [private]

Definition at line 30 of file voice.py.

---

Property Documentation

googlevoice::voice.Voice::contacts = property(contacts) [static]

Definition at line 182 of file voice.py.

googlevoice::voice.Voice::phones = property(phones) [static]

Definition at line 127 of file voice.py.

googlevoice::voice.Voice::settings = property(settings) [static]

Definition at line 134 of file voice.py.

googlevoice::voice.Voice::special = property(special) [static]

Definition at line 47 of file voice.py.

---

The documentation for this class was generated from the following file:

• voice.py