|
65 | 65 | </li> |
66 | 66 | <li class="toctree-l1 current"><a class="current reference internal" href="#">Real Time Messaging</a><ul> |
67 | 67 | <li class="toctree-l2"><a class="reference internal" href="#connecting-to-the-real-time-messaging-api">Connecting to the Real Time Messaging API</a></li> |
68 | | -<li class="toctree-l2"><a class="reference internal" href="#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li> |
69 | 68 | <li class="toctree-l2"><a class="reference internal" href="#rtm-events">RTM Events</a></li> |
70 | 69 | <li class="toctree-l2"><a class="reference internal" href="#sending-messages-via-the-rtm-api">Sending messages via the RTM API</a></li> |
71 | 70 | </ul> |
@@ -160,28 +159,6 @@ <h2>Connecting to the Real Time Messaging API<a class="headerlink" href="#connec |
160 | 159 | </pre></div> |
161 | 160 | </div> |
162 | 161 | </div> |
163 | | -<div class="section" id="rtm-start-vs-rtm-connect"> |
164 | | -<h2>rtm.start vs rtm.connect<a class="headerlink" href="#rtm-start-vs-rtm-connect" title="Permalink to this headline">¶</a></h2> |
165 | | -<p>If you expect your app to be used on large teams, we recommend starting the RTM client with <cite>rtm.connect</cite> rather than the default connection method for this client, <cite>rtm.start</cite>. |
166 | | -<cite>rtm.connect</cite> provides a lighter initial connection payload, without the team’s channel and user information included. You’ll need to request channel and user info via |
167 | | -the Web API separately.</p> |
168 | | -<p>To do this, simply pass <cite>with_team_state=False</cite> into the <cite>rtm_connect</cite> call, like so:</p> |
169 | | -<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">slackclient</span> <span class="kn">import</span> <span class="n">SlackClient</span> |
170 | | - |
171 | | -<span class="n">slack_token</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"SLACK_API_TOKEN"</span><span class="p">]</span> |
172 | | -<span class="n">sc</span> <span class="o">=</span> <span class="n">SlackClient</span><span class="p">(</span><span class="n">slack_token</span><span class="p">)</span> |
173 | | - |
174 | | -<span class="k">if</span> <span class="n">sc</span><span class="o">.</span><span class="n">rtm_connect</span><span class="p">(</span><span class="n">with_team_state</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span> |
175 | | - <span class="k">while</span> <span class="bp">True</span><span class="p">:</span> |
176 | | - <span class="k">print</span> <span class="n">sc</span><span class="o">.</span><span class="n">rtm_read</span><span class="p">()</span> |
177 | | - <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> |
178 | | -<span class="k">else</span><span class="p">:</span> |
179 | | - <span class="k">print</span> <span class="s2">"Connection Failed"</span> |
180 | | -</pre></div> |
181 | | -</div> |
182 | | -<p>See the <a class="reference external" href="https://api.slack.com/methods/rtm.start">rtm.start docs</a> and the <a href="#id3"><span class="problematic" id="id4">`rtm.connect docs<https://api.slack.com/methods/rtm.connect>`_</span></a> |
183 | | -for more details.</p> |
184 | | -</div> |
185 | 162 | <div class="section" id="rtm-events"> |
186 | 163 | <h2>RTM Events<a class="headerlink" href="#rtm-events" title="Permalink to this headline">¶</a></h2> |
187 | 164 | <div class="highlight-python"><div class="highlight"><pre><span></span><span class="p">{</span> |
|
0 commit comments