PushService

消息来到你身边

单客户端推送

推送到指定 cid

pushSingleCid(String targetCid, PushMessage msg)

将消息msg推送给 cid 为targetCid的客户端。

Params

Name	Type	Description
targetCid	String	客户端的 cid
msg	PushMessage	要推送给客户端的消息

Returns

String data : 个推接口返回的 data 字段，如发生错误则为 "error".

Example

// PushMessage msg = ...

String res = ps.pushSingleCid("HanashikiiPhone", msg);

推送到指定 alias

pushSingleAlias(String targetAlias, PushMessage msg)

将消息msg推送给 alias 为targetAlias的客户端。

Params

Name	Type	Description
targetAlias	String	客户端的 alias
msg	PushMessage	要推送给客户端的消息

Returns

String data : 个推接口返回的 data 字段，如发生错误则为 "error".

Example

// PushMessage msg = ...

String res = ps.pushSingleAlias("Chen@Base", msg);

---

多客户端推送（独立消息）

推送到指定 cid

pushBatchCid(HashMap<String, PushMessage> tasks)

指定一组tasks，每个 task 由 cid 与消息组成。一次调用会将每个消息推送给其对应的 cid, 最多一次推送 200 组。

Params

Name	Type	Description
tasks	HashMap<String, PushMessage>	<客户端的 cid, 要推送给该客户端的消息> 键值对组成的 HashMap

Returns

String data : 个推接口返回的 data 字段，如发生错误则为 "error".

Example

// PushMessage msg1, msg2 = ...
HashMap<String, PushMessage> tasks = new HashMap<String, PushMessage>();
tasks.put("HanashikiiPhone", msg1);
tasks.put("337845818", msg2);

String res = ps.pushBatchCid(tasks);

推送到指定 alias

pushBatchAlias(HashMap<String, PushMessage> tasks)

指定一组tasks，每个 task 由 alias 与消息组成。一次调用会将每个消息推送给其对应的 alias, 最多一次推送 200 组。

Params

Name	Type	Description
tasks	HashMap<String, PushMessage>	<客户端的 alias, 要推送给该客户端的消息> 键值对组成的HashMap

Returns

String data : 个推接口返回的 data 字段，如发生错误则为 "error".

Example

// PushMessage msg1, msg2 = ...
HashMap<String, PushMessage> tasks = new HashMap<String, PushMessage>();
tasks.put("Chen@Nost", msg1);
tasks.put("Chen@Base", msg2);

String res = ps.pushBatchAlias(tasks);

---

多客户端推送（相同消息）

按列表推送

个推支持先构造一条消息到个推服务器，之后，在有需要时，向一个客户端列表内的所有用户推送事先上传的消息。

准备推送消息

pushListMessage(PushMessage msg)

将消息msg预存到服务器。

Params

Name	Type	Description
msg	PushMessage	要推送给客户端的消息

Returns

String taskId : 个推接口返回的 taskId 字段。

请注意保存此方法返回的 taskId, 之后对此消息的推送是使用 taskId 索引的。

Example

// PushMessage msg = ...

String taskId = ps.pushListMessage(msg);

推送准备好的消息（cid）

pushListCid(String[] targets, String taskId)

将索引为taskId的消息推送给targets列表中的所有用户，最多接受1000个用户。

Params

Name	Type	Description
targets	String[]	目标客户端的 Cid 列表
taskId	String	已预存的推送消息的 taskId

Returns

String data : 个推接口返回的 data 字段，如发生错误则为 "error".

Example

// PushMessage msg = ...
// String taskId = ps.PushListMessage(msg) // success

String[] cidList = new String[] { "FakeCid1", "FakeCid2", "FakeCid3" };
String res = ps.pushListCid(cidList, taskId);

推送准备好的消息（alias）

pushListAlias(String[] targets, String taskId)

将索引为taskId的消息推送给targets列表中的所有用户，最多接受1000个用户。

Params

Name	Type	Description
targets	String[]	目标客户端的 Alias 列表
taskId	String	已预存的推送消息的 taskId

Returns

String data : 个推接口返回的 data 字段，如发生错误则为 "error".

Example

// PushMessage msg = ...
// String taskId = ps.PushListMessage(msg) // success

String[] aliasList = new String[] { "FakeAlias1", "FakeAlias2" };
String res = ps.pushListAlias(aliasList, taskId);

推送给带有特定标签组合的所有用户

pushTag(Tag[] tags, PushMessage msg)

将消息msg推送给由标签列表tags定义的用户组，其中不同 Tag 支持交、并、补集操作。

Params

Name	Type	Description
tags	Tag[]	标签数组，其详细构造参见
msg	PushMessage	要推送给客户端的消息

Returns

String data : 个推接口返回的 data 字段，如发生错误则为 "error".

Example

// PushMessage msg = ...
// TODO: write the tags & example
Tag[] tags = new tagsBuilder(). todo //明天一定写

String res = ps.pushTag(tags, msg);

推送给带某一标签的所有用户

pushFastTag(String fastTag, PushMessage msg)

将消息msg推送给所有被fastTag标签标记的用户。

Params

Name	Type	Description
fastTag	String	用来筛选用户的标签
msg	PushMessage	要推送给客户端的消息

Returns

String data : 个推接口返回的 data 字段，如发生错误则为 "error".

Example

// PushMessage msg = ...

String res = ps.pushFastTag("iOS15-", msg);

---

全体推送

推送给所有 App 用户

pushAll(PushMessage msg)

将消息msg推送给 App 全体用户。

Params

Name	Type	Description
msg	PushMessage	要推送给客户端的消息

Returns

String taskId : 个推接口返回的 taskid 字段，可以此为凭据对推送进行后续处理（撤销，查询等）。

Example

// PushMessage msg = ...

String taskId = ps.pushAll(msg);