Package openid :: Package extensions :: Module ax :: Class FetchResponse
[frames | no frames]

Type FetchResponse

object --+            
         |            
 Extension --+        
             |        
     AXMessage --+    
                 |    
 AXKeyValueMessage --+
                     |
                    FetchResponse


A fetch_response attribute exchange message
Method Summary
  __init__(self, request, update_url)
  fromSuccessResponse(cls, success_response, signed)
Construct a FetchResponse object from an OpenID library SuccessResponse object. (Class method)
{unicode;unicode} getExtensionArgs(self)
Serialize this object into arguments in the attribute exchange namespace
  parseExtensionArgs(self, ax_args)
Inherited from Extension: toMessage
Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variable Summary
NoneType mode: The type of this attribute exchange message.

Instance Method Details

__init__(self, request=None, update_url=None)
(Constructor)

Parameters:
request - When supplied, I will use namespace aliases that match those in this request. I will also check to make sure I do not respond with attributes that were not requested.
           (type=FetchRequest)
update_url - By default, update_url is taken from the request. But if you do not supply the request, you may set the update_url here.
           (type=str)
Overrides:
openid.extensions.ax.AXKeyValueMessage.__init__

getExtensionArgs(self)

Serialize this object into arguments in the attribute exchange namespace
Returns:
The dictionary of unqualified attribute exchange arguments that represent this fetch_response.
           (type={unicode;unicode})
Overrides:
openid.extension.Extension.getExtensionArgs

parseExtensionArgs(self, ax_args)

Overrides:
openid.extensions.ax.AXKeyValueMessage.parseExtensionArgs

See Also: {Extension.parseExtensionArgs<openid.extension.Extension.parseExtensionArgs>}


Class Method Details

fromSuccessResponse(cls, success_response, signed=True)

Construct a FetchResponse object from an OpenID library SuccessResponse object.
Parameters:
success_response - A successful id_res response object
           (type=openid.consumer.consumer.SuccessResponse)
signed - Whether non-signed args should be processsed. If True (the default), only signed arguments will be processsed.
           (type=bool)
Returns:
A FetchResponse containing the data from the OpenID message, or None if the SuccessResponse did not contain AX extension data.
Raises:
AXError - when the AX data cannot be parsed.

Class Variable Details

mode

The type of this attribute exchange message. This must be overridden in subclasses.
Type:
NoneType
Value:
'fetch_response'                                                       

Generated by Epydoc 2.1 on Wed Apr 22 16:14:21 2009 http://epydoc.sf.net