python-sdk/docs/_modules/leancloud/push.html at python-310 · leancloud/python-sdk

History

205 lines (173 loc) · 16.2 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

<!DOCTYPE html>

<head>

<title>leancloud.push — LeanCloud-Python-SDK 2.6.1 文档</title>

<!--[if lt IE 9]>

<![endif]-->

</head>

<a href="../../index.html" class="icon icon-home"> LeanCloud-Python-SDK

</a>

2.6

</div>

</form>

</div>

</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">

</div>

</nav>

<a href="../../index.html">LeanCloud-Python-SDK</a>

</nav>

<li>leancloud.push</li>

</li>

</ul>

<hr/>

</div>

<h1>leancloud.push 源代码</h1><div class="highlight"><pre>

# coding: utf-8

from __future__ import absolute_import

from __future__ import division

from __future__ import print_function

from __future__ import unicode_literals

import arrow

import dateutil.tz as tz

from leancloud.object_ import Object

from leancloud.errors import LeanCloudError

from leancloud import client

__author__ = "asaka <[email protected]>"

<div class="viewcode-block" id="Installation"><a class="viewcode-back" href="../../index.html#leancloud.push.Installation">[文档]</a>class Installation(Object):

pass</div>

<div class="viewcode-block" id="Notification"><a class="viewcode-back" href="../../index.html#leancloud.push.Notification">[文档]</a>class Notification(Object):

<div class="viewcode-block" id="Notification.fetch"><a class="viewcode-back" href="../../index.html#leancloud.push.Notification.fetch">[文档]</a> def fetch(self, *args, **kwargs):

"""同步服务器的 Notification 数据

"""

response = client.get("/tables/Notifications/{0}".format(self.id))

self._update_data(response.json())</div>

<div class="viewcode-block" id="Notification.save"><a class="viewcode-back" href="../../index.html#leancloud.push.Notification.save">[文档]</a> def save(self, *args, **kwargs):

raise LeanCloudError(code=1, error="Notification does not support modify")</div></div>

def _encode_time(time):

tzinfo = time.tzinfo

if tzinfo is None:

tzinfo = tz.tzlocal()

return arrow.get(time, tzinfo).to("utc").format("YYYY-MM-DDTHH:mm:ss.SSS") + "Z"

<div class="viewcode-block" id="send"><a class="viewcode-back" href="../../index.html#leancloud.push.send">[文档]</a>def send(

data,

channels=None,

push_time=None,

expiration_time=None,

expiration_interval=None,

where=None,

cql=None,

flow_control=None,

prod=None,

):

"""

发送推送消息。返回结果为此条推送对应的 _Notification 表中的对象，但是如果需要使用其中的数据，需要调用 fetch() 方法将数据同步至本地。

:param channels: 需要推送的频道

:type channels: list or tuple

:param push_time: 推送的时间

:type push_time: datetime

:param expiration_time: 消息过期的绝对日期时间

:type expiration_time: datetime

:param expiration_interval: 消息过期的相对时间，从调用 API 的时间开始算起，单位是秒

:type expiration_interval: int

:param where: 一个查询 _Installation 表的查询条件 leancloud.Query 对象

:type where: leancloud.Query

:param cql: 一个查询 _Installation 表的查询条件 CQL 语句

:type cql: string_types

:param data: 推送给设备的具体信息，详情查看 https://leancloud.cn/docs/push_guide.html#消息内容_Data

:rtype: Notification

:param flow_control: 不为 None 时开启平滑推送，值为每秒推送的目标终端用户数。开启时指定低于 1000 的值，按 1000 计。

:type: flow_control: int

:param prod: 仅对 iOS 推送有效，设置将推送发至 APNs 的开发环境（dev）还是生产环境（prod）。

:type: prod: string

"""

if expiration_interval and expiration_time:

raise TypeError("Both expiration_time and expiration_interval can't be set")

params = {

"data": data,

}

if prod is None:

if client.USE_PRODUCTION == "0":

params["prod"] = "dev"

else:

params["prod"] = prod

if channels:

params["channels"] = channels

if push_time:

params["push_time"] = _encode_time(push_time)

if expiration_time:

params["expiration_time"] = _encode_time(expiration_time)

if expiration_interval:

params["expiration_interval"] = expiration_interval

if where:

params["where"] = where.dump().get("where", {})

if cql:

params["cql"] = cql

# Do not change this to `if flow_control`, because 0 is falsy in Python,

# but `flow_control = 0` will enable smooth push,

# and it is in fact equivalent to `flow_control = 1000`.

if flow_control is not None:

params["flow_control"] = flow_control

result = client.post("/push", params=params).json()

notification = Notification.create_without_data(result["objectId"])

return notification</div>

</pre></div>

</div>

<hr/>

</div>

利用 <a href="https://www.sphinx-doc.org/">Sphinx</a> 构建，使用了

由 <a href="https://readthedocs.org">Read the Docs</a>开发.

</footer>

</div>

</section>

</div>

jQuery(function () {

SphinxRtdTheme.Navigation.enable(true);

});

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

push.html

Latest commit

History

push.html

File metadata and controls