Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

docs: update api doc #475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
weakish merged 1 commit into from
May 20, 2020
Merged

docs: update api doc #475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion 6 docs/_modules/leancloud/client.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,11 @@ <h1>leancloud.client 源代码</h1><div class="highlight"><pre>
<span class="s2">&quot;Content-Type&quot;</span><span class="p">:</span> <span class="s2">&quot;application/json;charset=utf-8&quot;</span><span class="p">,</span>
<span class="s2">&quot;X-LC-Id&quot;</span><span class="p">:</span> <span class="n">APP_ID</span><span class="p">,</span>
<span class="s2">&quot;X-LC-Prod&quot;</span><span class="p">:</span> <span class="n">USE_PRODUCTION</span><span class="p">,</span>
<span class="s2">&quot;User-Agent&quot;</span><span class="p">:</span> <span class="s2">&quot;AVOS Cloud python-</span><span class="si">{0}</span><span class="s2"> SDK&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">leancloud</span><span class="o">.</span><span class="n">__version__</span><span class="p">),</span>
<span class="s2">&quot;User-Agent&quot;</span><span class="p">:</span> <span class="s2">&quot;AVOS Cloud python-</span><span class="si">{0}</span><span class="s2"> SDK (</span><span class="si">{1}</span><span class="s2">.</span><span class="si">{2}</span><span class="s2">)&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">leancloud</span><span class="o">.</span><span class="n">__version__</span><span class="p">,</span>
<span class="n">leancloud</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">major</span><span class="p">,</span>
<span class="n">leancloud</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">minor</span><span class="p">,</span>
<span class="p">),</span>
<span class="p">}</span>
<span class="n">md5sum</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">md5</span><span class="p">()</span>
<span class="n">current_time</span> <span class="o">=</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">*</span> <span class="mi">1000</span><span class="p">))</span>
Expand Down
10 changes: 8 additions & 2 deletions 10 docs/_modules/leancloud/push.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ <h1>leancloud.push 源代码</h1><div class="highlight"><pre>
<span class="n">where</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">cql</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">flow_control</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">prod</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> 发送推送消息。返回结果为此条推送对应的 _Notification 表中的对象，但是如果需要使用其中的数据，需要调用 fetch() 方法将数据同步至本地。</span>
Expand All @@ -215,6 +216,8 @@ <h1>leancloud.push 源代码</h1><div class="highlight"><pre>
<span class="sd"> :rtype: Notification</span>
<span class="sd"> :param flow_control: 不为 None 时开启平滑推送，值为每秒推送的目标终端用户数。开启时指定低于 1000 的值，按 1000 计。</span>
<span class="sd"> :type: flow_control: int</span>
<span class="sd"> :param prod: 仅对 iOS 推送有效，设置将推送发至 APNs 的开发环境（dev）还是生产环境（prod）。</span>
<span class="sd"> :type: prod: string</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">expiration_interval</span> <span class="ow">and</span> <span class="n">expiration_time</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Both expiration_time and expiration_interval can&#39;t be set&quot;</span><span class="p">)</span>
Expand All @@ -223,8 +226,11 @@ <h1>leancloud.push 源代码</h1><div class="highlight"><pre>
<span class="s2">&quot;data&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">,</span>
<span class="p">}</span>

<span class="k">if</span> <span class="n">client</span><span class="o">.</span><span class="n">USE_PRODUCTION</span> <span class="o">==</span> <span class="s2">&quot;0&quot;</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;prod&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;dev&quot;</span>
<span class="k">if</span> <span class="n">prod</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">client</span><span class="o">.</span><span class="n">USE_PRODUCTION</span> <span class="o">==</span> <span class="s2">&quot;0&quot;</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;prod&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;dev&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;prod&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">prod</span>

<span class="k">if</span> <span class="n">channels</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;channels&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">channels</span>
Expand Down
6 changes: 5 additions & 1 deletion 6 docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2795,7 +2795,7 @@ <h3>CookieSessionMiddleware<a class="headerlink" href="#cookiesessionmiddleware"

<dl class="py function">
<dt id="leancloud.push.send">
<code class="sig-prename descclassname">leancloud.push.</code><code class="sig-name descname">send</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">channels</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">push_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expiration_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expiration_interval</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">where</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cql</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">flow_control</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/leancloud/push.html#send"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#leancloud.push.send" title="永久链接至目标">¶</a></dt>
<code class="sig-prename descclassname">leancloud.push.</code><code class="sig-name descname">send</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">channels</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">push_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expiration_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expiration_interval</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">where</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cql</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">flow_control</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">prod</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/leancloud/push.html#send"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#leancloud.push.send" title="永久链接至目标">¶</a></dt>
<dd><p>发送推送消息。返回结果为此条推送对应的 _Notification 表中的对象，但是如果需要使用其中的数据，需要调用 fetch() 方法将数据同步至本地。</p>
<dl class="field-list simple">
<dt class="field-odd">参数</dt>
Expand All @@ -2808,6 +2808,7 @@ <h3>CookieSessionMiddleware<a class="headerlink" href="#cookiesessionmiddleware"
<li><p><strong>cql</strong> (<em>string_types</em>) – 一个查询 _Installation 表的查询条件 CQL 语句</p></li>
<li><p><strong>data</strong> – 推送给设备的具体信息，详情查看 <a class="reference external" href="https://leancloud.cn/docs/push_guide">https://leancloud.cn/docs/push_guide</a>.html#消息内容_Data</p></li>
<li><p><strong>flow_control</strong> – 不为 None 时开启平滑推送，值为每秒推送的目标终端用户数。开启时指定低于 1000 的值，按 1000 计。</p></li>
<li><p><strong>prod</strong> – 仅对 iOS 推送有效，设置将推送发至 APNs 的开发环境（dev）还是生产环境（prod）。</p></li>
</ul>
</dd>
<dt class="field-even">返回类型</dt>
Expand All @@ -2816,6 +2817,9 @@ <h3>CookieSessionMiddleware<a class="headerlink" href="#cookiesessionmiddleware"
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>flow_control: int</p>
</dd>
<dt class="field-even">Type</dt>
<dd class="field-even"><p>prod: string</p>
</dd>
</dl>
</dd></dl>

Expand Down
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.