skype4py.client.iclient-class.html

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

    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a href="Skype4Py.client.IClient-class.html#IsRunning" class="summary-name">IsRunning</a><br />
      Tells if Skype client is running.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">unicode</span>
    </td><td class="summary">
        <a href="Skype4Py.client.IClient-class.html#Wallpaper" class="summary-name">Wallpaper</a><br />
      Path to client wallpaper bitmap.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="Skype4Py.enums-module.html#wndUnknown" class="link">Window 
      state</a></span>
    </td><td class="summary">
        <a href="Skype4Py.client.IClient-class.html#WindowState" class="summary-name">WindowState</a><br />
      Client window state.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">Skype</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Skype4Py.client-pysrc.html#IClient.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>__init__.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>Skype</code></strong> (<a href="Skype4Py.skype.ISkype-class.html" 
          class="link">ISkype</a>) - Skype</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="ButtonPressed"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ButtonPressed</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">Key</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Skype4Py.client-pysrc.html#IClient.ButtonPressed">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends button button pressed to client.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>Key</code></strong> (unicode) - Key</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="ButtonReleased"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ButtonReleased</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">Key</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Skype4Py.client-pysrc.html#IClient.ButtonReleased">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends button released event to client.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>Key</code></strong> (unicode) - Key</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="CreateEvent"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">CreateEvent</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">EventId</span>,
        <span class="sig-arg">Caption</span>,
        <span class="sig-arg">Hint</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Skype4Py.client-pysrc.html#IClient.CreateEvent">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Creates a custom event displayed in Skype client's events pane.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>EventId</code></strong> (unicode) - Unique identifier for the event.</li>
        <li><strong class="pname"><code>Caption</code></strong> (unicode) - Caption text.</li>
        <li><strong class="pname"><code>Hint</code></strong> (unicode) - Hint text. Shown when mouse hoovers over the event.</li>
    </ul></dd>
    <dt>Returns: <a href="Skype4Py.client.IPluginEvent-class.html" 
      class="link">IPluginEvent</a></dt>
        <dd>Event object.</dd>
  </dl>
</td></tr></table>
</div>
<a name="CreateMenuItem"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">CreateMenuItem</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">MenuItemId</span>,
        <span class="sig-arg">PluginContext</span>,
        <span class="sig-arg">CaptionText</span>,
        <span class="sig-arg">HintText</span>=<span class="sig-default"><code class="variable-quote">u'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">IconPath</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">Enabled</span>=<span class="sig-default">True</span>,
        <span class="sig-arg">ContactType</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">all</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">MultipleContacts</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Skype4Py.client-pysrc.html#IClient.CreateMenuItem">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Creates custom menu item in Skype client's &quot;Do More&quot; 
  menus.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>MenuItemId</code></strong> (unicode) - Unique identifier for the menu item.</li>
        <li><strong class="pname"><code>PluginContext</code></strong> (<a href="Skype4Py.enums-module.html#pluginContextUnknown" 
          class="link">Plug-in context</a>) - Menu item context. Allows to choose in which client windows will 
          the menu item appear.</li>
        <li><strong class="pname"><code>CaptionText</code></strong> (unicode) - Caption text.</li>
        <li><strong class="pname"><code>HintText</code></strong> (unicode) - Hint text (optional). Shown when mouse hoovers over the menu 
          item.</li>
        <li><strong class="pname"><code>IconPath</code></strong> (unicode) - Path to the icon (optional).</li>
        <li><strong class="pname"><code>Enabled</code></strong> (bool) - Initial state of the menu item. True by default.</li>
        <li><strong class="pname"><code>ContactType</code></strong> (<a href="Skype4Py.enums-module.html#pluginContactTypeUnknown" 
          class="link">Plug-in contact type</a>) - In case of <a 
          href="Skype4Py.enums-module.html#pluginContextContact" 
          class="link">pluginContextContact</a> tells which contacts the 
          menu item should appear for. Defaults to <a 
          href="Skype4Py.enums-module.html#pluginContactTypeAll" 
          class="link">pluginContactTypeAll</a>.</li>
        <li><strong class="pname"><code>MultipleContacts</code></strong> (bool) - Set to True if multiple contacts should be allowed (defaults to 
          False).</li>
    </ul></dd>
    <dt>Returns: <a href="Skype4Py.client.IPluginMenuItem-class.html" 
      class="link">IPluginMenuItem</a></dt>
        <dd>Menu item object.</dd>
  </dl>
</td></tr></table>
</div>
<a name="OpenAddContactDialog"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">OpenAddContactDialog</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">Username</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Skype4Py.client-pysrc.html#IClient.OpenAddContactDialog">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Opens &quot;Add a Contact&quot; dialog.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>Username</code></strong> (unicode) - Optional Skypename of the contact.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="OpenAuthorizationDialog"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">OpenAuthorizationDialog</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">Username</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Skype4Py.client-pysrc.html#IClient.OpenAuthorizationDialog">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Opens authorization dialog.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>Username</code></strong> (unicode) - Skypename of the user to authenticate.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="OpenDialog"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">OpenDialog</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">Name</span>,
        <span class="sig-arg">*Params</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Skype4Py.client-pysrc.html#IClient.OpenDialog">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Open dialog. Use this method to open dialogs added in newer Skype 
  versions if there is no dedicated method in Skype4Py.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>Name</code></strong> (unicode) - Dialog name.</li>