skype4py.client-pysrc.html

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

<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">        @param CaptionText: Caption text.</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">        @type CaptionText: unicode</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring">        @param HintText: Hint text (optional). Shown when mouse hoovers over the menu item.</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">        @type HintText: unicode</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line"><tt class="py-docstring">        @param IconPath: Path to the icon (optional).</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"><tt class="py-docstring">        @type IconPath: unicode</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"><tt class="py-docstring">        @param Enabled: Initial state of the menu item. True by default.</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"><tt class="py-docstring">        @type Enabled: bool</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line"><tt class="py-docstring">        @param ContactType: In case of L{pluginContextContact&lt;enums.pluginContextContact&gt;} tells which contacts</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring">        the menu item should appear for. Defaults to L{pluginContactTypeAll&lt;enums.pluginContactTypeAll&gt;}.</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">        @type ContactType: L{Plug-in contact type&lt;enums.pluginContactTypeUnknown&gt;}</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">        @param MultipleContacts: Set to True if multiple contacts should be allowed (defaults to False).</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">        @type MultipleContacts: bool</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-docstring">        @return: Menu item object.</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: L{IPluginMenuItem}</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line">        <tt class="py-name">com</tt> <tt class="py-op">=</tt> <tt class="py-string">'CREATE MENU_ITEM %s CONTEXT %s CAPTION %s ENABLED %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">MenuItemId</tt><tt class="py-op">,</tt> <tt class="py-name">PluginContext</tt><tt class="py-op">,</tt> <tt id="link-10" class="py-name"><a title="Skype4Py.utils.quote" class="py-name" href="#" onclick="return doclink('link-10', 'quote', 'link-4');">quote</a></tt><tt class="py-op">(</tt><tt class="py-name">CaptionText</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-11" class="py-name" targets="Function Skype4Py.utils.cndexp()=Skype4Py.utils-module.html#cndexp"><a title="Skype4Py.utils.cndexp" class="py-name" href="#" onclick="return doclink('link-11', 'cndexp', 'link-11');">cndexp</a></tt><tt class="py-op">(</tt><tt id="link-12" class="py-name" targets="Variable Skype4Py.client.IPluginMenuItem.Enabled=Skype4Py.client.IPluginMenuItem-class.html#Enabled"><a title="Skype4Py.client.IPluginMenuItem.Enabled" class="py-name" href="#" onclick="return doclink('link-12', 'Enabled', 'link-12');">Enabled</a></tt><tt class="py-op">,</tt> <tt class="py-string">'true'</tt><tt class="py-op">,</tt> <tt class="py-string">'false'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">HintText</tt><tt class="py-op">:</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line">            <tt class="py-name">com</tt> <tt class="py-op">+=</tt> <tt class="py-string">' HINT %s'</tt> <tt class="py-op">%</tt> <tt id="link-13" class="py-name"><a title="Skype4Py.utils.quote" class="py-name" href="#" onclick="return doclink('link-13', 'quote', 'link-4');">quote</a></tt><tt class="py-op">(</tt><tt class="py-name">HintText</tt><tt class="py-op">)</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">IconPath</tt><tt class="py-op">:</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line">            <tt class="py-name">com</tt> <tt class="py-op">+=</tt> <tt class="py-string">' ICON %s'</tt> <tt class="py-op">%</tt> <tt id="link-14" class="py-name"><a title="Skype4Py.utils.quote" class="py-name" href="#" onclick="return doclink('link-14', 'quote', 'link-4');">quote</a></tt><tt class="py-op">(</tt><tt class="py-name">IconPath</tt><tt class="py-op">)</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">MultipleContacts</tt><tt class="py-op">:</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line">            <tt class="py-name">com</tt> <tt class="py-op">+=</tt> <tt class="py-string">' ENABLE_MULTIPLE_CONTACTS true'</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">PluginContext</tt> <tt class="py-op">==</tt> <tt id="link-15" class="py-name" targets="Variable Skype4Py.enums.pluginContextContact=Skype4Py.enums-module.html#pluginContextContact"><a title="Skype4Py.enums.pluginContextContact" class="py-name" href="#" onclick="return doclink('link-15', 'pluginContextContact', 'link-15');">pluginContextContact</a></tt><tt class="py-op">:</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line">            <tt class="py-name">com</tt> <tt class="py-op">+=</tt> <tt class="py-string">' CONTACT_TYPE_FILTER %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">ContactType</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Skype</tt><tt class="py-op">.</tt><tt class="py-name">_DoCommand</tt><tt class="py-op">(</tt><tt class="py-name">com</tt><tt class="py-op">)</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-16" class="py-name" targets="Class Skype4Py.client.IPluginMenuItem=Skype4Py.client.IPluginMenuItem-class.html"><a title="Skype4Py.client.IPluginMenuItem" class="py-name" href="#" onclick="return doclink('link-16', 'IPluginMenuItem', 'link-16');">IPluginMenuItem</a></tt><tt class="py-op">(</tt><tt class="py-name">MenuItemId</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Skype</tt><tt class="py-op">,</tt> <tt class="py-name">CaptionText</tt><tt class="py-op">,</tt> <tt class="py-name">HintText</tt><tt class="py-op">,</tt> <tt id="link-17" class="py-name"><a title="Skype4Py.client.IPluginMenuItem.Enabled" class="py-name" href="#" onclick="return doclink('link-17', 'Enabled', 'link-12');">Enabled</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"> </tt>
<a name="IClient.Focus"></a><div id="IClient.Focus-def"><a name="L90"></a><tt class="py-lineno"> 90</tt> <a class="py-toggle" href="#" id="IClient.Focus-toggle" onclick="return toggle('IClient.Focus');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#Focus">Focus</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.Focus-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.Focus-expanded"><a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line">        <tt class="py-docstring">'''Brings the client window into focus.</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Skype</tt><tt class="py-op">.</tt><tt class="py-name">_DoCommand</tt><tt class="py-op">(</tt><tt class="py-string">'FOCUS'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"> </tt>
<a name="IClient.Minimize"></a><div id="IClient.Minimize-def"><a name="L95"></a><tt class="py-lineno"> 95</tt> <a class="py-toggle" href="#" id="IClient.Minimize-toggle" onclick="return toggle('IClient.Minimize');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#Minimize">Minimize</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.Minimize-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.Minimize-expanded"><a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line">        <tt class="py-docstring">'''Hides Skype application window.</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Skype</tt><tt class="py-op">.</tt><tt class="py-name">_DoCommand</tt><tt class="py-op">(</tt><tt class="py-string">'MINIMIZE'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"> </tt>
<a name="IClient.OpenAddContactDialog"></a><div id="IClient.OpenAddContactDialog-def"><a name="L100"></a><tt class="py-lineno">100</tt> <a class="py-toggle" href="#" id="IClient.OpenAddContactDialog-toggle" onclick="return toggle('IClient.OpenAddContactDialog');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#OpenAddContactDialog">OpenAddContactDialog</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Username</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.OpenAddContactDialog-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.OpenAddContactDialog-expanded"><a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line">        <tt class="py-docstring">'''Opens "Add a Contact" dialog.</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"><tt class="py-docstring">        @param Username: Optional Skypename of the contact.</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-docstring">        @type Username: unicode</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name" targets="Method Skype4Py.client.IClient.OpenDialog()=Skype4Py.client.IClient-class.html#OpenDialog"><a title="Skype4Py.client.IClient.OpenDialog" class="py-name" href="#" onclick="return doclink('link-18', 'OpenDialog', 'link-18');">OpenDialog</a></tt><tt class="py-op">(</tt><tt class="py-string">'ADDAFRIEND'</tt><tt class="py-op">,</tt> <tt class="py-name">Username</tt><tt class="py-op">)</tt> </tt>
</div><a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"> </tt>
<a name="IClient.OpenAuthorizationDialog"></a><div id="IClient.OpenAuthorizationDialog-def"><a name="L108"></a><tt class="py-lineno">108</tt> <a class="py-toggle" href="#" id="IClient.OpenAuthorizationDialog-toggle" onclick="return toggle('IClient.OpenAuthorizationDialog');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#OpenAuthorizationDialog">OpenAuthorizationDialog</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Username</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.OpenAuthorizationDialog-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.OpenAuthorizationDialog-expanded"><a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line">        <tt class="py-docstring">'''Opens authorization dialog.</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring">        @param Username: Skypename of the user to authenticate.</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring">        @type Username: unicode</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="Skype4Py.client.IClient.OpenDialog" class="py-name" href="#" onclick="return doclink('link-19', 'OpenDialog', 'link-18');">OpenDialog</a></tt><tt class="py-op">(</tt><tt class="py-string">'AUTHORIZATION'</tt><tt class="py-op">,</tt> <tt class="py-name">Username</tt><tt class="py-op">)</tt> </tt>
</div><a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"> </tt>
<a name="IClient.OpenBlockedUsersDialog"></a><div id="IClient.OpenBlockedUsersDialog-def"><a name="L116"></a><tt class="py-lineno">116</tt> <a class="py-toggle" href="#" id="IClient.OpenBlockedUsersDialog-toggle" onclick="return toggle('IClient.OpenBlockedUsersDialog');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#OpenBlockedUsersDialog">OpenBlockedUsersDialog</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.OpenBlockedUsersDialog-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.OpenBlockedUsersDialog-expanded"><a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line">        <tt class="py-docstring">'''Opens blocked users dialog.</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="Skype4Py.client.IClient.OpenDialog" class="py-name" href="#" onclick="return doclink('link-20', 'OpenDialog', 'link-18');">OpenDialog</a></tt><tt class="py-op">(</tt><tt class="py-string">'BLOCKEDUSERS'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"> </tt>
<a name="IClient.OpenCallHistoryTab"></a><div id="IClient.OpenCallHistoryTab-def"><a name="L121"></a><tt class="py-lineno">121</tt> <a class="py-toggle" href="#" id="IClient.OpenCallHistoryTab-toggle" onclick="return toggle('IClient.OpenCallHistoryTab');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#OpenCallHistoryTab">OpenCallHistoryTab</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.OpenCallHistoryTab-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.OpenCallHistoryTab-expanded"><a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line">        <tt class="py-docstring">'''Opens call history tab.</tt> </tt>