303 lines
12 KiB
HTML
303 lines
12 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="zh-CN" > <![endif]-->
|
|||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="zh-CN" > <!--<![endif]-->
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>get_entity() — Xtaothon Documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="canonical" href="https://docs.xtaolabs.com/api/methods/get_entity.html"/>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
|||
|
|
<script src="../../_static/jquery.js"></script>
|
|||
|
|
<script src="../../_static/underscore.js"></script>
|
|||
|
|
<script src="../../_static/doctools.js"></script>
|
|||
|
|
<script src="../../_static/clipboard.min.js"></script>
|
|||
|
|
<script src="../../_static/copybutton.js"></script>
|
|||
|
|
<script src="../../_static/translations.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="../../_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="../../_static/tabs.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="index" title="索引" href="../../genindex.html" />
|
|||
|
|
<link rel="search" title="搜索" href="../../search.html" />
|
|||
|
|
<link rel="next" title="get_input_entity()" href="get_input_entity.html" />
|
|||
|
|
<link rel="prev" title="get_me()" href="get_me.html" />
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="../../index.html">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<img src="../../_static/xtaothon.png" class="logo" alt="Logo"/>
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">简介</span></p>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../intro/quickstart.html">快速开始</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../intro/install.html">安装指南</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<p class="caption"><span class="caption-text">开始</span></p>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../start/auth.html">授权</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../start/invoking.html">调用方法</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../start/updates.html">处理消息</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<p class="caption"><span class="caption-text">API</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../client.html">客户端</a></li>
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="index.html">可用方法</a><ul class="current">
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="index.html#id3">基础</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="index.html#id4">消息</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="index.html#id5">上传</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="index.html#id6">下载</a></li>
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="index.html#id7">用户</a><ul class="current">
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="get_me.html">get_me</a></li>
|
|||
|
|
<li class="toctree-l3 current"><a class="current reference internal" href="#">get_entity</a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="get_input_entity.html">get_input_entity</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../types/index.html">可用类型</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../bound-methods/index.html">绑定方法</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../handlers.html">消息更新处理器</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<p class="caption"><span class="caption-text">主题指南</span></p>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../topics/proxy.html">SOCKS5 Proxy</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../topics/text-formatting.html">文本格式</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<p class="caption"><span class="caption-text">更多</span></p>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">FAQ</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">常见短语</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../support.html">支持 Xtaothon</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="../../index.html">xtaothon</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
|
|||
|
|
<div class="rst-content style-external-links">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="../../index.html">Docs</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="index.html">可用方法</a> »</li>
|
|||
|
|
|
|||
|
|
<li>get_entity()</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!-- User defined GitHub URL -->
|
|||
|
|
<a href="https://github.com/Xtao-Labs/docs-all" class="fa fa-github"> Edit on GitHub</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="get-entity">
|
|||
|
|
<h1>get_entity()<a class="headerlink" href="#get-entity" title="永久链接至标题">¶</a></h1>
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="telethon.Client.get_entity">
|
|||
|
|
<code class="sig-prename descclassname"><span class="pre">Client.</span></code><code class="sig-name descname"><span class="pre">get_entity</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#telethon.Client.get_entity" title="永久链接至目标">¶</a></dt>
|
|||
|
|
<dd><p>获取指定对话信息。</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">注解</p>
|
|||
|
|
<p>使用此方法解析用户名不会自带缓存，对时间内您一般解析 <code class="docutils literal notranslate"><span class="pre">50</span></code> 个用户名就会收到请求过快错误。
|
|||
|
|
推荐优先使用 .. automethod:: telethon.Client.get_input_entity() 来请求缓存的用户名数据。</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="simple">
|
|||
|
|
<dt>参数:</dt><dd><dl class="simple">
|
|||
|
|
<dt>entity (<code class="docutils literal notranslate"><span class="pre">str</span></code> | <code class="docutils literal notranslate"><span class="pre">int</span></code>):</dt><dd><p>需要获取的对话的对象。</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">引发</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>ValueError</strong> – 指定的对话不存在。</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">返回</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="../types/user.html#telethon.tl.types.user" title="telethon.tl.types.user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">user</span></code></a> | <a class="reference internal" href="../types/chat.html#telethon.tl.types.chat" title="telethon.tl.types.chat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">chat</span></code></a> | <a class="reference internal" href="../types/channel.html#telethon.tl.types.channel" title="telethon.tl.types.channel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">channel</span></code></a> – 如果请求成功。</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<p class="rubric">示例</p>
|
|||
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">telethon</span> <span class="kn">import</span> <span class="n">utils</span>
|
|||
|
|
|
|||
|
|
<span class="n">me</span> <span class="o">=</span> <span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">get_entity</span><span class="p">(</span><span class="s1">'me'</span><span class="p">)</span>
|
|||
|
|
<span class="nb">print</span><span class="p">(</span><span class="n">utils</span><span class="o">.</span><span class="n">get_display_name</span><span class="p">(</span><span class="n">me</span><span class="p">))</span>
|
|||
|
|
|
|||
|
|
<span class="n">chat</span> <span class="o">=</span> <span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">get_input_entity</span><span class="p">(</span><span class="s1">'username'</span><span class="p">)</span>
|
|||
|
|
<span class="k">async</span> <span class="k">for</span> <span class="n">message</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">iter_messages</span><span class="p">(</span><span class="n">chat</span><span class="p">):</span>
|
|||
|
|
<span class="o">...</span>
|
|||
|
|
|
|||
|
|
<span class="c1"># 可以直接使用用户名</span>
|
|||
|
|
<span class="k">async</span> <span class="k">for</span> <span class="n">message</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">iter_messages</span><span class="p">(</span><span class="s1">'username'</span><span class="p">):</span>
|
|||
|
|
<span class="o">...</span>
|
|||
|
|
|
|||
|
|
<span class="c1"># 请注意，您的联系人中必须拥有此电话号码才可以请求到数据。</span>
|
|||
|
|
<span class="n">some_id</span> <span class="o">=</span> <span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">get_peer_id</span><span class="p">(</span><span class="s1">'+34123456789'</span><span class="p">)</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="get_input_entity.html" class="btn btn-neutral float-right" title="get_input_entity()" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="get_me.html" class="btn btn-neutral float-left" title="get_me()" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(false);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|