Files
Hippolyzer/docs/html/modules/agentdomain.html
2009-10-15 21:48:05 +00:00

153 lines
7.4 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>agentdomain &mdash; Pyogp v0.1 documentation</title>
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
<link rel="up" title="Modules" href="../modules.html" />
<link rel="next" title="agentmanager" href="agentmanager.html" />
<link rel="prev" title="agent" href="agent.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="agentmanager.html" title="agentmanager"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="agent.html" title="agent"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Pyogp v0.1 documentation</a> &raquo;</li>
<li><a href="../modules.html" accesskey="U">Modules</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="agent.html"
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">agent</span></tt></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="agentmanager.html"
title="next chapter"><tt class="docutils literal"><span class="pre">agentmanager</span></tt></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/modules/agentdomain.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-pyogp.lib.base.agentdomain">
<h1><tt class="xref docutils literal"><span class="pre">agentdomain</span></tt><a class="headerlink" href="#module-pyogp.lib.base.agentdomain" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyogp.lib.base.agentdomain.AgentDomain">
<em class="property">
class </em><tt class="descclassname">pyogp.lib.base.agentdomain.</tt><tt class="descname">AgentDomain</tt><big>(</big><em>uri</em>, <em>restclient=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain" title="Permalink to this definition"></a></dt>
<dd><p>an agent domain endpoint</p>
<p>initialize the agent domain endpoint</p>
<dl class="method">
<dt id="pyogp.lib.base.agentdomain.AgentDomain.eval_login_response">
<tt class="descname">eval_login_response</tt><big>(</big><em>response</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.eval_login_response" title="Permalink to this definition"></a></dt>
<dd>parse the login uri response</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.agentdomain.AgentDomain.get_agentdomain_capabilities">
<tt class="descname">get_agentdomain_capabilities</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.get_agentdomain_capabilities" title="Permalink to this definition"></a></dt>
<dd>queries the region seed cap for capabilities</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.agentdomain.AgentDomain.login">
<tt class="descname">login</tt><big>(</big><em>credentials</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.login" title="Permalink to this definition"></a></dt>
<dd>login to the agent domain</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.agentdomain.AgentDomain.parse_login_response">
<tt class="descname">parse_login_response</tt><big>(</big><em>response</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.parse_login_response" title="Permalink to this definition"></a></dt>
<dd>parse the login uri response and returns deserialized data</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.agentdomain.AgentDomain.place_avatar">
<tt class="descname">place_avatar</tt><big>(</big><em>region_uri</em>, <em>position=</em><span class="optional">[</span>, <em>117</em>, <em>73</em>, <em>21</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.place_avatar" title="Permalink to this definition"></a></dt>
<dd>handles the rez_avatar/place cap on the agent domain, populates some initial region attributes</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.agentdomain.AgentDomain.post_to_loginuri">
<tt class="descname">post_to_loginuri</tt><big>(</big><em>credentials</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.post_to_loginuri" title="Permalink to this definition"></a></dt>
<dd>post to login_uri and return response</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="agentmanager.html" title="agentmanager"
>next</a> |</li>
<li class="right" >
<a href="agent.html" title="agent"
>previous</a> |</li>
<li><a href="../index.html">Pyogp v0.1 documentation</a> &raquo;</li>
<li><a href="../modules.html" >Modules</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Pyogp team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
</div>
</body>
</html>