skype4py.api-pysrc.html

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

<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-docstring">    To send a command to Skype, use L{ISkype.SendCommand&lt;skype.ISkype.SendCommand&gt;}.</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"> </tt>
<a name="ICommand.__init__"></a><div id="ICommand.__init__-def"><a name="L24"></a><tt class="py-lineno"> 24</tt> <a class="py-toggle" href="#" id="ICommand.__init__-toggle" onclick="return toggle('ICommand.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.API.ICommand-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">Id</tt><tt class="py-op">,</tt> <tt class="py-param">Command</tt><tt class="py-op">,</tt> <tt class="py-param">Expected</tt><tt class="py-op">=</tt><tt class="py-string">u''</tt><tt class="py-op">,</tt> <tt class="py-param">Blocking</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">Timeout</tt><tt class="py-op">=</tt><tt class="py-number">30000</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ICommand.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ICommand.__init__-expanded"><a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line">        <tt class="py-docstring">'''Use L{ISkype.Command&lt;skype.ISkype.Command&gt;} to instatinate the object instead.</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">Blocking</tt> <tt class="py-op">=</tt> <tt class="py-name">Blocking</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line">        <tt class="py-string">'''If set to True, L{ISkype.SendCommand&lt;skype.ISkype.SendCommand&gt;} will block until the reply is received.</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-string">        @type: bool'''</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method Skype4Py.skype.ISkype.Command()=Skype4Py.skype.ISkype-class.html#Command,Method Skype4Py.skype.ISkypeEvents.Command()=Skype4Py.skype.ISkypeEvents-class.html#Command"><a title="Skype4Py.skype.ISkype.Command
Skype4Py.skype.ISkypeEvents.Command" class="py-name" href="#" onclick="return doclink('link-7', 'Command', 'link-7');">Command</a></tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt id="link-8" class="py-name"><a title="Skype4Py.skype.ISkype.Command
Skype4Py.skype.ISkypeEvents.Command" class="py-name" href="#" onclick="return doclink('link-8', 'Command', 'link-7');">Command</a></tt><tt class="py-op">)</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line">        <tt class="py-string">'''Command string.</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-string">        @type: unicode'''</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">Expected</tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">Expected</tt><tt class="py-op">)</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line">        <tt class="py-string">'''Expected reply.</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-string">        @type: unicode'''</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Variable Skype4Py.call.ICall.Id=Skype4Py.call.ICall-class.html#Id,Variable Skype4Py.call.IConference.Id=Skype4Py.call.IConference-class.html#Id,Variable Skype4Py.call.IParticipant.Id=Skype4Py.call.IParticipant-class.html#Id,Variable Skype4Py.chat.IChatMember.Id=Skype4Py.chat.IChatMember-class.html#Id,Variable Skype4Py.chat.IChatMessage.Id=Skype4Py.chat.IChatMessage-class.html#Id,Variable Skype4Py.client.IPluginEvent.Id=Skype4Py.client.IPluginEvent-class.html#Id,Variable Skype4Py.client.IPluginMenuItem.Id=Skype4Py.client.IPluginMenuItem-class.html#Id,Variable Skype4Py.filetransfer.IFileTransfer.Id=Skype4Py.filetransfer.IFileTransfer-class.html#Id,Variable Skype4Py.sms.ISmsChunk.Id=Skype4Py.sms.ISmsChunk-class.html#Id,Variable Skype4Py.sms.ISmsMessage.Id=Skype4Py.sms.ISmsMessage-class.html#Id,Variable Skype4Py.user.IGroup.Id=Skype4Py.user.IGroup-class.html#Id,Variable Skype4Py.voicemail.IVoicemail.Id=Skype4Py.voicemail.IVoicemail-class.html#Id"><a title="Skype4Py.call.ICall.Id
Skype4Py.call.IConference.Id
Skype4Py.call.IParticipant.Id
Skype4Py.chat.IChatMember.Id
Skype4Py.chat.IChatMessage.Id
Skype4Py.client.IPluginEvent.Id
Skype4Py.client.IPluginMenuItem.Id
Skype4Py.filetransfer.IFileTransfer.Id
Skype4Py.sms.ISmsChunk.Id
Skype4Py.sms.ISmsMessage.Id
Skype4Py.user.IGroup.Id
Skype4Py.voicemail.IVoicemail.Id" class="py-name" href="#" onclick="return doclink('link-9', 'Id', 'link-9');">Id</a></tt> <tt class="py-op">=</tt> <tt id="link-10" class="py-name"><a title="Skype4Py.call.ICall.Id
Skype4Py.call.IConference.Id
Skype4Py.call.IParticipant.Id
Skype4Py.chat.IChatMember.Id
Skype4Py.chat.IChatMessage.Id
Skype4Py.client.IPluginEvent.Id
Skype4Py.client.IPluginMenuItem.Id
Skype4Py.filetransfer.IFileTransfer.Id
Skype4Py.sms.ISmsChunk.Id
Skype4Py.sms.ISmsMessage.Id
Skype4Py.user.IGroup.Id
Skype4Py.voicemail.IVoicemail.Id" class="py-name" href="#" onclick="return doclink('link-10', 'Id', 'link-9');">Id</a></tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line">        <tt class="py-string">'''Command Id.</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-string">        @type: int'''</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Method Skype4Py.skype.ISkypeEvents.Reply()=Skype4Py.skype.ISkypeEvents-class.html#Reply"><a title="Skype4Py.skype.ISkypeEvents.Reply" class="py-name" href="#" onclick="return doclink('link-11', 'Reply', 'link-11');">Reply</a></tt> <tt class="py-op">=</tt> <tt class="py-string">u''</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line">        <tt class="py-string">'''Reply after the command has been sent and Skype has replied.</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-string">        @type: unicode'''</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"> </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 id="link-12" class="py-name" targets="Variable Skype4Py.skype.ISkype.Timeout=Skype4Py.skype.ISkype-class.html#Timeout"><a title="Skype4Py.skype.ISkype.Timeout" class="py-name" href="#" onclick="return doclink('link-12', 'Timeout', 'link-12');">Timeout</a></tt> <tt class="py-op">=</tt> <tt id="link-13" class="py-name"><a title="Skype4Py.skype.ISkype.Timeout" class="py-name" href="#" onclick="return doclink('link-13', 'Timeout', 'link-12');">Timeout</a></tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line">        <tt class="py-string">'''Timeout in milliseconds if Blocking=True.</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-string">        @type: int'''</tt> </tt>
</div><a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"> </tt>
<a name="ICommand.__repr__"></a><div id="ICommand.__repr__-def"><a name="L52"></a><tt class="py-lineno"> 52</tt> <a class="py-toggle" href="#" id="ICommand.__repr__-toggle" onclick="return toggle('ICommand.__repr__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.API.ICommand-class.html#__repr__">__repr__</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="ICommand.__repr__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ICommand.__repr__-expanded"><a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-string">'&lt;%s with Id=%s, Command=%s, Blocking=%s, Reply=%s&gt;'</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line">            <tt class="py-op">(</tt><tt class="py-name">object</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Method Skype4Py.API.ICommand.__repr__()=Skype4Py.API.ICommand-class.html#__repr__,Method Skype4Py.API.darwin.CFNumber.__repr__()=Skype4Py.API.darwin.CFNumber-class.html#__repr__,Method Skype4Py.API.darwin.CFString.__repr__()=Skype4Py.API.darwin.CFString-class.html#__repr__,Method Skype4Py.API.darwin.CFType.__repr__()=Skype4Py.API.darwin.CFType-class.html#__repr__,Method Skype4Py.application.IApplication.__repr__()=Skype4Py.application.IApplication-class.html#__repr__,Method Skype4Py.application.IApplicationStream.__repr__()=Skype4Py.application.IApplicationStream-class.html#__repr__,Method Skype4Py.call.ICall.__repr__()=Skype4Py.call.ICall-class.html#__repr__,Method Skype4Py.call.IConference.__repr__()=Skype4Py.call.IConference-class.html#__repr__,Method Skype4Py.call.IParticipant.__repr__()=Skype4Py.call.IParticipant-class.html#__repr__,Method Skype4Py.callchannel.ICallChannel.__repr__()=Skype4Py.callchannel.ICallChannel-class.html#__repr__,Method Skype4Py.chat.IChat.__repr__()=Skype4Py.chat.IChat-class.html#__repr__,Method Skype4Py.chat.IChatMember.__repr__()=Skype4Py.chat.IChatMember-class.html#__repr__,Method Skype4Py.chat.IChatMessage.__repr__()=Skype4Py.chat.IChatMessage-class.html#__repr__,Method Skype4Py.client.IPluginEvent.__repr__()=Skype4Py.client.IPluginEvent-class.html#__repr__,Method Skype4Py.client.IPluginMenuItem.__repr__()=Skype4Py.client.IPluginMenuItem-class.html#__repr__,Method Skype4Py.filetransfer.IFileTransfer.__repr__()=Skype4Py.filetransfer.IFileTransfer-class.html#__repr__,Method Skype4Py.sms.ISmsChunk.__repr__()=Skype4Py.sms.ISmsChunk-class.html#__repr__,Method Skype4Py.sms.ISmsMessage.__repr__()=Skype4Py.sms.ISmsMessage-class.html#__repr__,Method Skype4Py.sms.ISmsTarget.__repr__()=Skype4Py.sms.ISmsTarget-class.html#__repr__,Method Skype4Py.user.IGroup.__repr__()=Skype4Py.user.IGroup-class.html#__repr__,Method Skype4Py.user.IUser.__repr__()=Skype4Py.user.IUser-class.html#__repr__,Method Skype4Py.voicemail.IVoicemail.__repr__()=Skype4Py.voicemail.IVoicemail-class.html#__repr__"><a title="Skype4Py.API.ICommand.__repr__
Skype4Py.API.darwin.CFNumber.__repr__
Skype4Py.API.darwin.CFString.__repr__
Skype4Py.API.darwin.CFType.__repr__
Skype4Py.application.IApplication.__repr__
Skype4Py.application.IApplicationStream.__repr__
Skype4Py.call.ICall.__repr__
Skype4Py.call.IConference.__repr__
Skype4Py.call.IParticipant.__repr__
Skype4Py.callchannel.ICallChannel.__repr__
Skype4Py.chat.IChat.__repr__
Skype4Py.chat.IChatMember.__repr__
Skype4Py.chat.IChatMessage.__repr__
Skype4Py.client.IPluginEvent.__repr__
Skype4Py.client.IPluginMenuItem.__repr__
Skype4Py.filetransfer.IFileTransfer.__repr__
Skype4Py.sms.ISmsChunk.__repr__
Skype4Py.sms.ISmsMessage.__repr__
Skype4Py.sms.ISmsTarget.__repr__
Skype4Py.user.IGroup.__repr__
Skype4Py.user.IUser.__repr__
Skype4Py.voicemail.IVoicemail.__repr__" class="py-name" href="#" onclick="return doclink('link-14', '__repr__', 'link-14');">__repr__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</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-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 id="link-15" class="py-name"><a title="Skype4Py.call.ICall.Id