skype4py.conversion-pysrc.html

基于python的skype的API的说明文档

<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"> </tt>
<a name="IConversion"></a><div id="IConversion-def"><a name="L19"></a><tt class="py-lineno"> 19</tt> <a class="py-toggle" href="#" id="IConversion-toggle" onclick="return toggle('IConversion');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="Skype4Py.conversion.IConversion-class.html">IConversion</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IConversion-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="IConversion-expanded"><a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line">    <tt class="py-docstring">'''Allows conversion between constants and text. Access using L{ISkype.Convert&lt;skype.ISkype.Convert&gt;}.</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"> </tt>
<a name="IConversion.__init__"></a><div id="IConversion.__init__-def"><a name="L23"></a><tt class="py-lineno"> 23</tt> <a class="py-toggle" href="#" id="IConversion.__init__-toggle" onclick="return toggle('IConversion.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.conversion.IConversion-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Skype</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IConversion.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IConversion.__init__-expanded"><a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line">        <tt class="py-docstring">'''__init__.</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring">        @param Skype: Skype object.</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">        @type Skype: L{ISkype}</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Language</tt> <tt class="py-op">=</tt> <tt class="py-string">u''</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Module</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Method Skype4Py.conversion.IConversion._SetLanguage()=Skype4Py.conversion.IConversion-class.html#_SetLanguage,Method Skype4Py.settings.ISettings._SetLanguage()=Skype4Py.settings.ISettings-class.html#_SetLanguage"><a title="Skype4Py.conversion.IConversion._SetLanguage
Skype4Py.settings.ISettings._SetLanguage" class="py-name" href="#" onclick="return doclink('link-2', '_SetLanguage', 'link-2');">_SetLanguage</a></tt><tt class="py-op">(</tt><tt class="py-string">'en'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"> </tt>
<a name="IConversion._TextTo"></a><div id="IConversion._TextTo-def"><a name="L33"></a><tt class="py-lineno"> 33</tt> <a class="py-toggle" href="#" id="IConversion._TextTo-toggle" onclick="return toggle('IConversion._TextTo');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.conversion.IConversion-class.html#_TextTo">_TextTo</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">prefix</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IConversion._TextTo-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IConversion._TextTo-expanded"><a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line">        <tt class="py-name">enum</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">z</tt> <tt class="py-keyword">for</tt> <tt class="py-name">z</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">y</tt><tt class="py-op">,</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt id="link-3" class="py-name"><a title="Skype4Py.enums" class="py-name" href="#" onclick="return doclink('link-3', 'enums', 'link-0');">enums</a></tt><tt class="py-op">,</tt> <tt class="py-name">y</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">y</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-name">x</tt> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dir</tt><tt class="py-op">(</tt><tt id="link-4" class="py-name"><a title="Skype4Py.enums" class="py-name" href="#" onclick="return doclink('link-4', 'enums', 'link-0');">enums</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> <tt class="py-name">x</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-name">prefix</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-keyword">if</tt> <tt class="py-name">z</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">value</tt><tt class="py-op">]</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">enum</tt><tt class="py-op">:</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad text'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"> </tt>
<a name="IConversion._ToText"></a><div id="IConversion._ToText-def"><a name="L39"></a><tt class="py-lineno"> 39</tt> <a class="py-toggle" href="#" id="IConversion._ToText-toggle" onclick="return toggle('IConversion._ToText');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.conversion.IConversion-class.html#_ToText">_ToText</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">prefix</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IConversion._ToText-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IConversion._ToText-expanded"><a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line">        <tt class="py-name">enum</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">z</tt> <tt class="py-keyword">for</tt> <tt class="py-name">z</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">y</tt><tt class="py-op">,</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt id="link-5" class="py-name"><a title="Skype4Py.enums" class="py-name" href="#" onclick="return doclink('link-5', 'enums', 'link-0');">enums</a></tt><tt class="py-op">,</tt> <tt class="py-name">y</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">y</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-name">x</tt> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dir</tt><tt class="py-op">(</tt><tt id="link-6" class="py-name"><a title="Skype4Py.enums" class="py-name" href="#" onclick="return doclink('link-6', 'enums', 'link-0');">enums</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> <tt class="py-name">x</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-name">prefix</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-keyword">if</tt> <tt class="py-name">z</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">value</tt><tt class="py-op">]</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">enum</tt><tt class="py-op">:</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Module</tt><tt class="py-op">,</tt> <tt class="py-name">enum</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line">                <tt class="py-keyword">pass</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad identifier'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"> </tt>
<a name="IConversion.AttachmentStatusToText"></a><div id="IConversion.AttachmentStatusToText-def"><a name="L48"></a><tt class="py-lineno"> 48</tt> <a class="py-toggle" href="#" id="IConversion.AttachmentStatusToText-toggle" onclick="return toggle('IConversion.AttachmentStatusToText');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.conversion.IConversion-class.html#AttachmentStatusToText">AttachmentStatusToText</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Status</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IConversion.AttachmentStatusToText-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IConversion.AttachmentStatusToText-expanded"><a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns attachment status as text.</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">        @param Status: Attachment status.</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">        @type Status: L{Attachment status&lt;enums.apiAttachUnknown&gt;}</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">        @return: Text describing the attachment status.</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: unicode</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ToText</tt><tt class="py-op">(</tt><tt class="py-string">'api'</tt><tt class="py-op">,</tt> <tt id="link-7" class="py-name" targets="Variable Skype4Py.call.ICall.Status=Skype4Py.call.ICall-class.html#Status,Variable Skype4Py.chat.IChat.Status=Skype4Py.chat.IChat-class.html#Status,Variable Skype4Py.chat.IChatMessage.Status=Skype4Py.chat.IChatMessage-class.html#Status,Variable Skype4Py.filetransfer.IFileTransfer.Status=Skype4Py.filetransfer.IFileTransfer-class.html#Status,Variable Skype4Py.sms.ISmsMessage.Status=Skype4Py.sms.ISmsMessage-class.html#Status,Variable Skype4Py.sms.ISmsTarget.Status=Skype4Py.sms.ISmsTarget-class.html#Status,Variable Skype4Py.voicemail.IVoicemail.Status=Skype4Py.voicemail.IVoicemail-class.html#Status"><a title="Skype4Py.call.ICall.Status
Skype4Py.chat.IChat.Status
Skype4Py.chat.IChatMessage.Status
Skype4Py.filetransfer.IFileTransfer.Status
Skype4Py.sms.ISmsMessage.Status
Skype4Py.sms.ISmsTarget.Status
Skype4Py.voicemail.IVoicemail.Status" class="py-name" href="#" onclick="return doclink('link-7', 'Status', 'link-7');">Status</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"> </tt>
<a name="IConversion.BuddyStatusToText"></a><div id="IConversion.BuddyStatusToText-def"><a name="L58"></a><tt class="py-lineno"> 58</tt> <a class="py-toggle" href="#" id="IConversion.BuddyStatusToText-toggle" onclick="return toggle('IConversion.BuddyStatusToText');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.conversion.IConversion-class.html#BuddyStatusToText">BuddyStatusToText</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Status</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IConversion.BuddyStatusToText-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IConversion.BuddyStatusToText-expanded"><a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns buddy status as text.</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">        @param Status: Buddy status.</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">        @type Status: L{Buddy status&lt;enums.budUnknown&gt;}</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">        @return: Text describing the buddy status.</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: unicode</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ToText</tt><tt class="py-op">(</tt><tt class="py-string">'bud'</tt><tt class="py-op">,</tt> <tt id="link-8" class="py-name"><a title="Skype4Py.call.ICall.Status
Skype4Py.chat.IChat.Status
Skype4Py.chat.IChatMessage.Status
Skype4Py.filetransfer.IFileTransfer.Status
Skype4Py.sms.ISmsMessage.Status
Skype4Py.sms.ISmsTarget.Status
Skype4Py.voicemail.IVoicemail.Status" class="py-name" href="#" onclick="return doclink('link-8', 'Status', 'link-7');">Status</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"> </tt>
<a name="IConversion.CallFailureReasonToText"></a><div id="IConversion.CallFailureReasonToText-def"><a name="L68"></a><tt class="py-lineno"> 68</tt> <a class="py-toggle" href="#" id="IConversion.CallFailureReasonToText-toggle" onclick="return toggle('IConversion.CallFailureReasonToText');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.conversion.IConversion-class.html#CallFailureReasonToText">CallFailureReasonToText</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Reason</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IConversion.CallFailureReasonToText-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IConversion.CallFailureReasonToText-expanded"><a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns failure reason as text.</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring">        @param Reason: Call failure reason.</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">        @type Reason: L{Call failure reason&lt;enums.cfrUnknown&gt;}</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">        @return: Text describing the call failure reason.</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: unicode</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_ToText</tt><tt class="py-op">(</tt><tt class="py-string">'cfr'</tt><tt class="py-op">,</tt> <tt class="py-name">Reason</tt><tt class="py-op">)</tt> </tt>
</div><a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"> </tt>
<a name="IConversion.CallStatusToText"></a><div id="IConversion.CallStatusToText-def"><a name="L78"></a><tt class="py-lineno"> 78</tt> <a class="py-toggle" href="#" id="IConversion.CallStatusToText-toggle" onclick="return toggle('IConversion.CallStatusToText');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.conversion.IConversion-class.html#CallStatusToText">CallStatusToText</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Status</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IConversion.CallStatusToText-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IConversion.CallStatusToText-expanded"><a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line">        <tt class="py-docstring">'''Returns call status as text.</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">        @param Status: Call status.</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">        @type Status: L{Call status&lt;enums.clsUnknown&gt;}</tt> </tt>