skype4py.chat-pysrc.html

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

</div><div id="IChat.OpenWindow-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IChat.OpenWindow-expanded"><a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line">        <tt class="py-docstring">'''Opens the chat window.</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</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 id="link-13" class="py-name" targets="Variable Skype4Py.skype.ISkype.Client=Skype4Py.skype.ISkype-class.html#Client"><a title="Skype4Py.skype.ISkype.Client" class="py-name" href="#" onclick="return doclink('link-13', 'Client', 'link-13');">Client</a></tt><tt class="py-op">.</tt><tt id="link-14" 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-14', 'OpenDialog', 'link-14');">OpenDialog</a></tt><tt class="py-op">(</tt><tt class="py-string">'CHAT'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Name</tt><tt class="py-op">)</tt> </tt>
</div><a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line"> </tt>
<a name="IChat.SendMessage"></a><div id="IChat.SendMessage-def"><a name="L93"></a><tt class="py-lineno"> 93</tt> <a class="py-toggle" href="#" id="IChat.SendMessage-toggle" onclick="return toggle('IChat.SendMessage');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.chat.IChat-class.html#SendMessage">SendMessage</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">MessageText</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IChat.SendMessage-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IChat.SendMessage-expanded"><a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line">        <tt class="py-docstring">'''Sends a chat message.</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring">        @param MessageText: Message text</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">        @type MessageText: unicode</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">        @return: Message object</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: L{IChatMessage}</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-15" class="py-name" targets="Class Skype4Py.chat.IChatMessage=Skype4Py.chat.IChatMessage-class.html"><a title="Skype4Py.chat.IChatMessage" class="py-name" href="#" onclick="return doclink('link-15', 'IChatMessage', 'link-15');">IChatMessage</a></tt><tt class="py-op">(</tt><tt id="link-16" class="py-name" targets="Function Skype4Py.utils.chop()=Skype4Py.utils-module.html#chop"><a title="Skype4Py.utils.chop" class="py-name" href="#" onclick="return doclink('link-16', 'chop', 'link-16');">chop</a></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">_DoCommand</tt><tt class="py-op">(</tt><tt class="py-string">'CHATMESSAGE %s %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Name</tt><tt class="py-op">,</tt> <tt class="py-name">MessageText</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">)</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">self</tt><tt class="py-op">.</tt><tt class="py-name">_Skype</tt><tt class="py-op">)</tt> </tt>
</div><a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"> </tt>
<a name="IChat.SetPassword"></a><div id="IChat.SetPassword-def"><a name="L103"></a><tt class="py-lineno">103</tt> <a class="py-toggle" href="#" id="IChat.SetPassword-toggle" onclick="return toggle('IChat.SetPassword');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.chat.IChat-class.html#SetPassword">SetPassword</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Password</tt><tt class="py-op">,</tt> <tt class="py-param">Hint</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="IChat.SetPassword-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IChat.SetPassword-expanded"><a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line">        <tt class="py-docstring">'''Sets the chat password.</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-docstring">        @param Password: Password</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"><tt class="py-docstring">        @type Password: unicode</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-docstring">        @param Hint: Password hint</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line"><tt class="py-docstring">        @type Hint: unicode</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-keyword">if</tt> <tt class="py-string">' '</tt> <tt class="py-keyword">in</tt> <tt class="py-name">Password</tt><tt class="py-op">:</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</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">'Password mut be one word'</tt><tt class="py-op">)</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Alter</tt><tt class="py-op">(</tt><tt class="py-string">'SETPASSWORD'</tt><tt class="py-op">,</tt> <tt class="py-string">'%s %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">Password</tt><tt class="py-op">,</tt> <tt id="link-17" class="py-name" targets="Variable Skype4Py.client.IPluginMenuItem.Hint=Skype4Py.client.IPluginMenuItem-class.html#Hint"><a title="Skype4Py.client.IPluginMenuItem.Hint" class="py-name" href="#" onclick="return doclink('link-17', 'Hint', 'link-17');">Hint</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"> </tt>
<a name="IChat.Unbookmark"></a><div id="IChat.Unbookmark-def"><a name="L115"></a><tt class="py-lineno">115</tt> <a class="py-toggle" href="#" id="IChat.Unbookmark-toggle" onclick="return toggle('IChat.Unbookmark');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.chat.IChat-class.html#Unbookmark">Unbookmark</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="IChat.Unbookmark-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IChat.Unbookmark-expanded"><a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line">        <tt class="py-docstring">'''Unbookmarks the chat.</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Alter</tt><tt class="py-op">(</tt><tt class="py-string">'UNBOOKMARK'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"> </tt>
<a name="IChat._GetActiveMembers"></a><div id="IChat._GetActiveMembers-def"><a name="L120"></a><tt class="py-lineno">120</tt> <a class="py-toggle" href="#" id="IChat._GetActiveMembers-toggle" onclick="return toggle('IChat._GetActiveMembers');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.chat.IChat-class.html#_GetActiveMembers">_GetActiveMembers</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="IChat._GetActiveMembers-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IChat._GetActiveMembers-expanded"><a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-18" class="py-name" targets="Class Skype4Py.user.IUser=Skype4Py.user.IUser-class.html"><a title="Skype4Py.user.IUser" class="py-name" href="#" onclick="return doclink('link-18', 'IUser', 'link-18');">IUser</a></tt><tt class="py-op">(</tt><tt class="py-name">x</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-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt id="link-19" class="py-name" targets="Function Skype4Py.utils.esplit()=Skype4Py.utils-module.html#esplit"><a title="Skype4Py.utils.esplit" class="py-name" href="#" onclick="return doclink('link-19', 'esplit', 'link-19');">esplit</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Property</tt><tt class="py-op">(</tt><tt class="py-string">'ACTIVEMEMBERS'</tt><tt class="py-op">,</tt> <tt id="link-20" class="py-name"><a title="Skype4Py.skype.ISkype.Cache" class="py-name" href="#" onclick="return doclink('link-20', 'Cache', 'link-8');">Cache</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line">    <tt id="link-21" class="py-name" targets="Variable Skype4Py.chat.IChat.ActiveMembers=Skype4Py.chat.IChat-class.html#ActiveMembers"><a title="Skype4Py.chat.IChat.ActiveMembers" class="py-name" href="#" onclick="return doclink('link-21', 'ActiveMembers', 'link-21');">ActiveMembers</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-22" class="py-name" targets="Method Skype4Py.chat.IChat._GetActiveMembers()=Skype4Py.chat.IChat-class.html#_GetActiveMembers"><a title="Skype4Py.chat.IChat._GetActiveMembers" class="py-name" href="#" onclick="return doclink('link-22', '_GetActiveMembers', 'link-22');">_GetActiveMembers</a></tt><tt class="py-op">,</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line">    <tt class="py-name">doc</tt><tt class="py-op">=</tt><tt class="py-string">'''Active members of a chat.</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"><tt class="py-string">    @type: tuple of L{IUser}</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line"><tt class="py-string">    '''</tt><tt class="py-op">)</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"> </tt>
<a name="IChat._GetActivityDatetime"></a><div id="IChat._GetActivityDatetime-def"><a name="L129"></a><tt class="py-lineno">129</tt> <a class="py-toggle" href="#" id="IChat._GetActivityDatetime-toggle" onclick="return toggle('IChat._GetActivityDatetime');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.chat.IChat-class.html#_GetActivityDatetime">_GetActivityDatetime</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="IChat._GetActivityDatetime-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IChat._GetActivityDatetime-expanded"><a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line">        <tt class="py-keyword">from</tt> <tt class="py-name">datetime</tt> <tt class="py-keyword">import</tt> <tt class="py-name">datetime</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">fromtimestamp</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name" targets="Variable Skype4Py.chat.IChat.ActivityTimestamp=Skype4Py.chat.IChat-class.html#ActivityTimestamp"><a title="Skype4Py.chat.IChat.ActivityTimestamp" class="py-name" href="#" onclick="return doclink('link-23', 'ActivityTimestamp', 'link-23');">ActivityTimestamp</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line"> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line">    <tt id="link-24" class="py-name" targets="Variable Skype4Py.chat.IChat.ActivityDatetime=Skype4Py.chat.IChat-class.html#ActivityDatetime"><a title="Skype4Py.chat.IChat.ActivityDatetime" class="py-name" href="#" onclick="return doclink('link-24', 'ActivityDatetime', 'link-24');">ActivityDatetime</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-25" class="py-name" targets="Method Skype4Py.chat.IChat._GetActivityDatetime()=Skype4Py.chat.IChat-class.html#_GetActivityDatetime"><a title="Skype4Py.chat.IChat._GetActivityDatetime" class="py-name" href="#" onclick="return doclink('link-25', '_GetActivityDatetime', 'link-25');">_GetActivityDatetime</a></tt><tt class="py-op">,</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line">    <tt class="py-name">doc</tt><tt class="py-op">=</tt><tt class="py-string">'''Returns chat activity timestamp as datetime.</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line"><tt class="py-string">    @type: datetime.datetime</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-string">    '''</tt><tt class="py-op">)</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"> </tt>
<a name="IChat._GetActivityTimestamp"></a><div id="IChat._GetActivityTimestamp-def"><a name="L139"></a><tt class="py-lineno">139</tt> <a class="py-toggle" href="#" id="IChat._GetActivityTimestamp-toggle" onclick="return toggle('IChat._GetActivityTimestamp');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.chat.IChat-class.html#_GetActivityTimestamp">_GetActivityTimestamp</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="IChat._GetActivityTimestamp-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IChat._GetActivityTimestamp-expanded"><a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Property</tt><tt class="py-op">(</tt><tt class="py-string">'ACTIVITY_TIMESTAMP'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line"> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line">    <tt id="link-26" class="py-name"><a title="Skype4Py.chat.IChat.ActivityTimestamp" class="py-name" href="#" onclick="return doclink('link-26', 'ActivityTimestamp', 'link-23');">ActivityTimestamp</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-27" class="py-name" targets="Method Skype4Py.chat.IChat._GetActivityTimestamp()=Skype4Py.chat.IChat-class.html#_GetActivityTimestamp"><a title="Skype4Py.chat.IChat._GetActivityTimestamp" class="py-name" href="#" onclick="return doclink('link-27', '_GetActivityTimestamp', 'link-27');">_GetActivityTimestamp</a></tt><tt class="py-op">,</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line">    <tt class="py-name">doc</tt><tt class="py-op">=</tt><tt class="py-string">'''Returns chat activity timestamp.</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-string">    @type: float</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line"><tt class="py-string">    @see: L{ActivityDatetime}</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"><tt class="py-string">    '''</tt><tt class="py-op">)</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line"> </tt>
<a name="IChat._GetAdder"></a><div id="IChat._GetAdder-def"><a name="L149"></a><tt class="py-lineno">149</tt> <a class="py-toggle" href="#" id="IChat._GetAdder-toggle" onclick="return toggle('IChat._GetAdder');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.chat.IChat-class.html#_GetAdder">_GetAdder</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>