skype4py.application-pysrc.html

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

<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">__Connect_stream</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-name">s</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</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 class="py-name">__Connect_event</tt><tt class="py-op">.</tt><tt class="py-name">set</tt><tt class="py-op">(</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="IApplication.Connect"></a><div id="IApplication.Connect-def"><a name="L33"></a><tt class="py-lineno"> 33</tt> <a class="py-toggle" href="#" id="IApplication.Connect-toggle" onclick="return toggle('IApplication.Connect');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.application.IApplication-class.html#Connect">Connect</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-param">WaitConnected</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IApplication.Connect-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IApplication.Connect-expanded"><a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line">        <tt class="py-docstring">'''Connects application to user.</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring">        @param Username: Name of the user to connect to.</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring">        @type Username: unicode</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">        @param WaitConnected: If True, causes the method to wait untill the connection is established.</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-docstring">        @type WaitConnected: bool</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">        @return: If C{WaitConnected} is True, returns the stream which can be used to send the data.</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">        Otherwise returns None.</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: L{IApplicationStream} or None</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">WaitConnected</tt><tt class="py-op">:</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_event</tt> <tt class="py-op">=</tt> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Event</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_stream</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">None</tt><tt class="py-op">]</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_username</tt> <tt class="py-op">=</tt> <tt class="py-name">Username</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_app_streams</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="Skype4Py.application.IApplication.Streams" class="py-name" href="#" onclick="return doclink('link-8', 'Streams', 'link-6');">Streams</a></tt><tt class="py-op">)</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</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-9" class="py-name" targets="Method Skype4Py.utils.EventHandlingBase.RegisterEventHandler()=Skype4Py.utils.EventHandlingBase-class.html#RegisterEventHandler"><a title="Skype4Py.utils.EventHandlingBase.RegisterEventHandler" class="py-name" href="#" onclick="return doclink('link-9', 'RegisterEventHandler', 'link-9');">RegisterEventHandler</a></tt><tt class="py-op">(</tt><tt class="py-string">'ApplicationStreams'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_app_streams</tt><tt class="py-op">)</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</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">'CONNECT'</tt><tt class="py-op">,</tt> <tt class="py-name">Username</tt><tt class="py-op">)</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_event</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</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-10" class="py-name" targets="Method Skype4Py.utils.EventHandlingBase.UnregisterEventHandler()=Skype4Py.utils.EventHandlingBase-class.html#UnregisterEventHandler"><a title="Skype4Py.utils.EventHandlingBase.UnregisterEventHandler" class="py-name" href="#" onclick="return doclink('link-10', 'UnregisterEventHandler', 'link-10');">UnregisterEventHandler</a></tt><tt class="py-op">(</tt><tt class="py-string">'ApplicationStreams'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_app_streams</tt><tt class="py-op">)</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</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">__Connect_stream</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line">            <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line">                <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_stream</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_event</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__Connect_username</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</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">'CONNECT'</tt><tt class="py-op">,</tt> <tt class="py-name">Username</tt><tt class="py-op">)</tt> </tt>
</div><a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"> </tt>
<a name="IApplication.Create"></a><div id="IApplication.Create-def"><a name="L60"></a><tt class="py-lineno"> 60</tt> <a class="py-toggle" href="#" id="IApplication.Create-toggle" onclick="return toggle('IApplication.Create');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.application.IApplication-class.html#Create">Create</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="IApplication.Create-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IApplication.Create-expanded"><a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line">        <tt class="py-docstring">'''Creates the APP2APP application in Skype client.</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</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">'CREATE APPLICATION %s'</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="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"> </tt>
<a name="IApplication.Delete"></a><div id="IApplication.Delete-def"><a name="L65"></a><tt class="py-lineno"> 65</tt> <a class="py-toggle" href="#" id="IApplication.Delete-toggle" onclick="return toggle('IApplication.Delete');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.application.IApplication-class.html#Delete">Delete</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="IApplication.Delete-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IApplication.Delete-expanded"><a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line">        <tt class="py-docstring">'''Deletes the APP2APP application in Skype client.</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</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">'DELETE APPLICATION %s'</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="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"> </tt>
<a name="IApplication.SendDatagram"></a><div id="IApplication.SendDatagram-def"><a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="IApplication.SendDatagram-toggle" onclick="return toggle('IApplication.SendDatagram');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.application.IApplication-class.html#SendDatagram">SendDatagram</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Text</tt><tt class="py-op">,</tt> <tt class="py-param">Streams</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IApplication.SendDatagram-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IApplication.SendDatagram-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line">        <tt class="py-docstring">'''Sends datagram to application streams.</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">        @param Text: Text to send.</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">        @type Text: unicode</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-docstring">        @param Streams: Streams to send the datagram to or None if all currently connected streams should be used.</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring">        @type Streams: sequence of L{IApplicationStream}</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-keyword">if</tt> <tt id="link-11" class="py-name"><a title="Skype4Py.application.IApplication.Streams" class="py-name" href="#" onclick="return doclink('link-11', 'Streams', 'link-6');">Streams</a></tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line">            <tt id="link-12" class="py-name"><a title="Skype4Py.application.IApplication.Streams" class="py-name" href="#" onclick="return doclink('link-12', 'Streams', 'link-6');">Streams</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="Skype4Py.application.IApplication.Streams" class="py-name" href="#" onclick="return doclink('link-13', 'Streams', 'link-6');">Streams</a></tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">s</tt> <tt class="py-keyword">in</tt> <tt id="link-14" class="py-name"><a title="Skype4Py.application.IApplication.Streams" class="py-name" href="#" onclick="return doclink('link-14', 'Streams', 'link-6');">Streams</a></tt><tt class="py-op">:</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line">            <tt class="py-name">s</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name" targets="Method Skype4Py.application.IApplication.SendDatagram()=Skype4Py.application.IApplication-class.html#SendDatagram,Method Skype4Py.application.IApplicationStream.SendDatagram()=Skype4Py.application.IApplicationStream-class.html#SendDatagram"><a title="Skype4Py.application.IApplication.SendDatagram
Skype4Py.application.IApplicationStream.SendDatagram" class="py-name" href="#" onclick="return doclink('link-15', 'SendDatagram', 'link-15');">SendDatagram</a></tt><tt class="py-op">(</tt><tt id="link-16" class="py-name" targets="Variable Skype4Py.callchannel.ICallChannelMessage.Text=Skype4Py.callchannel.ICallChannelMessage-class.html#Text,Variable Skype4Py.sms.ISmsChunk.Text=Skype4Py.sms.ISmsChunk-class.html#Text"><a title="Skype4Py.callchannel.ICallChannelMessage.Text
Skype4Py.sms.ISmsChunk.Text" class="py-name" href="#" onclick="return doclink('link-16', 'Text', 'link-16');">Text</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"> </tt>
<a name="IApplication._GetConnectableUsers"></a><div id="IApplication._GetConnectableUsers-def"><a name="L83"></a><tt class="py-lineno"> 83</tt> <a class="py-toggle" href="#" id="IApplication._GetConnectableUsers-toggle" onclick="return toggle('IApplication._GetConnectableUsers');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.application.IApplication-class.html#_GetConnectableUsers">_GetConnectableUsers</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="IApplication._GetConnectableUsers-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IApplication._GetConnectableUsers-expanded"><a name="L84"></a><tt class="py-lineno"> 84</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-17" 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-17', 'IUser', 'link-17');">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-18" 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-18', 'esplit', 'link-18');">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">'CONNECTABLE'</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="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line">    <tt id="link-19" class="py-name" targets="Variable Skype4Py.application.IApplication.ConnectableUsers=Skype4Py.application.IApplication-class.html#ConnectableUsers"><a title="Skype4Py.application.IApplication.ConnectableUsers" class="py-name" href="#" onclick="return doclink('link-19', 'ConnectableUsers', 'link-19');">ConnectableUsers</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-20" class="py-name" targets="Method Skype4Py.application.IApplication._GetConnectableUsers()=Skype4Py.application.IApplication-class.html#_GetConnectableUsers"><a title="Skype4Py.application.IApplication._GetConnectableUsers" class="py-name" href="#" onclick="return doclink('link-20', '_GetConnectableUsers', 'link-20');">_GetConnectableUsers</a></tt><tt class="py-op">,</tt> </tt>