skype4py.voicemail-pysrc.html

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

<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</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">'OPEN VOICEMAIL %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line"> </tt>
<a name="IVoicemail.OutputDevice"></a><div id="IVoicemail.OutputDevice-def"><a name="L92"></a><tt class="py-lineno"> 92</tt> <a class="py-toggle" href="#" id="IVoicemail.OutputDevice-toggle" onclick="return toggle('IVoicemail.OutputDevice');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.voicemail.IVoicemail-class.html#OutputDevice">OutputDevice</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">DeviceType</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">Set</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="IVoicemail.OutputDevice-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IVoicemail.OutputDevice-expanded"><a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line">        <tt class="py-docstring">'''Queries or sets the sound output device.</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"><tt class="py-docstring">        @param DeviceType: Sound output device type or None.</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring">        @type DeviceType: L{Call IO device type&lt;enums.callIoDeviceTypeUnknown&gt;} or None</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">        @param Set: Value the device should be set to or None.</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">        @type Set: unicode, int or None</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring">        @return: If DeviceType and Set are None, returns a dictionary of device types and their</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-docstring">        values. Dictionary contains only those device types, whose values were set. If the</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-docstring">        DeviceType is not None but Set is None, returns the current value of the device or</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring">        None if the device wasn't set. If Set is not None, sets a new value for the device.</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: unicode, dict or None</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">Set</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-comment"># get</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line">            <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt id="link-15" class="py-name"><a title="Skype4Py.utils.args2dict" class="py-name" href="#" onclick="return doclink('link-15', 'args2dict', 'link-7');">args2dict</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">'OUTPUT'</tt><tt class="py-op">,</tt> <tt id="link-16" class="py-name"><a title="Skype4Py.skype.ISkype.Cache" class="py-name" href="#" onclick="return doclink('link-16', 'Cache', 'link-6');">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>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">t</tt> <tt class="py-keyword">in</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">t</tt> <tt class="py-op">==</tt> <tt id="link-17" class="py-name"><a title="Skype4Py.enums.callIoDeviceTypePort" class="py-name" href="#" onclick="return doclink('link-17', 'callIoDeviceTypePort', 'link-9');">callIoDeviceTypePort</a></tt><tt class="py-op">:</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line">                    <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-name">t</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-name">t</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">DeviceType</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-comment"># get active devices</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">args</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">DeviceType</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line">        <tt class="py-keyword">elif</tt> <tt class="py-name">DeviceType</tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-comment"># set</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 class="py-name">_Alter</tt><tt class="py-op">(</tt><tt class="py-string">'SET_OUTPUT'</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">DeviceType</tt><tt class="py-op">,</tt> <tt id="link-18" class="py-name"><a title="Skype4Py.utils.quote" class="py-name" href="#" onclick="return doclink('link-18', 'quote', 'link-10');">quote</a></tt><tt class="py-op">(</tt><tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">Set</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'DeviceType must be specified if Set is used'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"> </tt>
<a name="IVoicemail.SetUnplayed"></a><div id="IVoicemail.SetUnplayed-def"><a name="L118"></a><tt class="py-lineno">118</tt> <a class="py-toggle" href="#" id="IVoicemail.SetUnplayed-toggle" onclick="return toggle('IVoicemail.SetUnplayed');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.voicemail.IVoicemail-class.html#SetUnplayed">SetUnplayed</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="IVoicemail.SetUnplayed-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IVoicemail.SetUnplayed-expanded"><a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line">        <tt class="py-docstring">'''Changes the status of a voicemail from played to unplayed.</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line">        <tt class="py-comment"># Note. Due to a bug in Skype (tested using 3.8.0.115) the reply from</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line">        <tt class="py-comment"># [ALTER VOICEMAIL &lt;id&gt; SETUNPLAYED] is [ALTER VOICEMAIL &lt;id&gt; DELETE]</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line">        <tt class="py-comment"># causing the _Alter method to fail. Therefore we have to use a direct</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line">        <tt class="py-comment"># _DoCommand instead.</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line">         </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line">        <tt class="py-comment">#self._Alter('SETUNPLAYED')</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</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">'ALTER VOICEMAIL %d SETUNPLAYED'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Id</tt><tt class="py-op">,</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line">                               <tt class="py-string">'ALTER VOICEMAIL %d'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"> </tt>
<a name="IVoicemail.StartPlayback"></a><div id="IVoicemail.StartPlayback-def"><a name="L130"></a><tt class="py-lineno">130</tt> <a class="py-toggle" href="#" id="IVoicemail.StartPlayback-toggle" onclick="return toggle('IVoicemail.StartPlayback');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.voicemail.IVoicemail-class.html#StartPlayback">StartPlayback</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="IVoicemail.StartPlayback-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IVoicemail.StartPlayback-expanded"><a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line">        <tt class="py-docstring">'''Starts playing downloaded voicemail.</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</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">'STARTPLAYBACK'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line"> </tt>
<a name="IVoicemail.StartPlaybackInCall"></a><div id="IVoicemail.StartPlaybackInCall-def"><a name="L135"></a><tt class="py-lineno">135</tt> <a class="py-toggle" href="#" id="IVoicemail.StartPlaybackInCall-toggle" onclick="return toggle('IVoicemail.StartPlaybackInCall');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.voicemail.IVoicemail-class.html#StartPlaybackInCall">StartPlaybackInCall</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="IVoicemail.StartPlaybackInCall-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IVoicemail.StartPlaybackInCall-expanded"><a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line">        <tt class="py-docstring">'''Starts playing downloaded voicemail during a call.</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</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">'STARTPLAYBACKINCALL'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"> </tt>
<a name="IVoicemail.StartRecording"></a><div id="IVoicemail.StartRecording-def"><a name="L140"></a><tt class="py-lineno">140</tt> <a class="py-toggle" href="#" id="IVoicemail.StartRecording-toggle" onclick="return toggle('IVoicemail.StartRecording');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.voicemail.IVoicemail-class.html#StartRecording">StartRecording</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="IVoicemail.StartRecording-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IVoicemail.StartRecording-expanded"><a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line">        <tt class="py-docstring">'''Stops playing a voicemail greeting and starts recording a voicemail message.</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</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">'STARTRECORDING'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"> </tt>
<a name="IVoicemail.StopPlayback"></a><div id="IVoicemail.StopPlayback-def"><a name="L145"></a><tt class="py-lineno">145</tt> <a class="py-toggle" href="#" id="IVoicemail.StopPlayback-toggle" onclick="return toggle('IVoicemail.StopPlayback');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.voicemail.IVoicemail-class.html#StopPlayback">StopPlayback</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="IVoicemail.StopPlayback-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IVoicemail.StopPlayback-expanded"><a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line">        <tt class="py-docstring">'''Stops playing downloaded voicemail.</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</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">'STOPPLAYBACK'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"> </tt>
<a name="IVoicemail.StopRecording"></a><div id="IVoicemail.StopRecording-def"><a name="L150"></a><tt class="py-lineno">150</tt> <a class="py-toggle" href="#" id="IVoicemail.StopRecording-toggle" onclick="return toggle('IVoicemail.StopRecording');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.voicemail.IVoicemail-class.html#StopRecording">StopRecording</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="IVoicemail.StopRecording-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IVoicemail.StopRecording-expanded"><a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line">        <tt class="py-docstring">'''Ends the recording of a voicemail message.</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>