Skip to content

Latest commit

 

History

History
545 lines (359 loc) · 12.4 KB

CROSS.md

File metadata and controls

545 lines (359 loc) · 12.4 KB
Raw

Cross 跨应用

JMessage Client

use JMessage\JMessage;

$appKey = 'xxxx';
$masterSecret = 'xxxx';

$client = new JMessage($appKey, $masterSecret);

跨应用管理群组成员

use JMessage\Cross\Member;

$member = new Member($client);

跨应用添加成员

$member->add($gid, $appKey, array $usernames)

参数：

$gid：表示要添加成员的群组 gid

$appKey：表示用户所属的 appKey

$usernames：表示要添加到群组的用户数组

示例：

# 跨应用把 appKey 为 'xxxxxx' 的应用下的用户 'username0' 和 'username1' 添加到群组 gid 为 'xxxx' 的群组中

$gid = 'xxxx';
$appKey = 'xxxxxx';
$usernames = ['username0', 'username1'];

$response = $member->add($gid, $appKey, $usernames);

跨应用移除成员

$member->remove($gid, $appKey, array $usernames);

参数：

$gid：表示要移除成员的群组 gid

$appKey：表示用户所属的 appKey

$usernames：表示要从群组移除的用户数组

示例：

# 跨应用从群组 gid 为 'xxxx' 的群组中把 appKey 为 'xxxxxx' 的应用下的用户 'username0' 和 'username1' 移除

$gid = 'xxxx';
$appKey = 'xxxxxx';
$usernames = ['username0', 'username1'];

$response = $member->remove($gid, $appKey, $usernames);

跨应用更新群组成员

跨应用管理成员的设置参数比较复杂，建议使用上面所述的 2 个方法

$member->update($gid, array $options);

参数：

$gid：表示要添加成员的群组 gid

$options：表示批量添加成员的选项数组

示例：

# 跨应用管理群组 'xxxx' 中的成员

$gid = 'xxxx';


$appKey0 => 'appkey_0';
$add0 = ['username0', 'username1'];
$remove0 = ['username2', 'username3'];

$appKey1 = 'appkey_1';
$add1 = ['username4', 'username5'];
$remove1 = ['username6', 'username7'];

$options0 = [
    [
        'appKey' => $appKey0,
        'add' => $add0,
        'remove' => $remove0
    ],[
        'appKey' => $appKey1,
        'add' => $add1,
        'remove' => $remove1]
];

# or

$options1 = [
    [
        'appKey' => 'appkey_0',
        'add' => ['username0', 'username1'],
        'remove' => ['username2', 'username3']
    ], [
        'appKey' => 'appkey_1',
        'add' => ['username4', 'username5'],
        'remove' => ['username6', 'username7']
    ]
];

$response = $member->update($gid, $options1);

跨应用获取群组成员列表

$member->listAll($gid);

参数：

$gid：表示群组 gid

示例：

# 跨应用获取群组 gid 为 'xxxx' 的群组的成员列表

$gid = 'xxxx';

$response = $member->listAll($gid);

跨应用管理黑名单

use JMessage\Cross\Blacklist;

$blacklist = new Blacklist($client);

跨应用获取黑名单列表

$blacklist->listAll($user);

参数：

$user：表示要跨应用获取其黑名单列表的用户

示例：

# 跨应用获取用户 'jiguang' 的黑名单列表

$user = 'jiguang';

$response = $blacklist->listAll($user);

跨应用添加黑名单

$blacklist->add($user, $appKey, array $usernames);

参数：

$user：表示要跨应用管理其黑名单的用户

$appKey：表示用户所属的 appKey

$usernames：表示要添加进黑名单的用户的数组

示例：

# 跨应用把用户 'username0' 和 'username1' 添加到用户 'jiguang' 的黑名单列表中

$user = 'jiguang';
$appKey = 'xxxxxx';
$username = ['username0', 'username1'];

$response = $blacklist->add($user, $appKey, $usernames);

跨应用移除黑名单

$blacklist->remove($user, $appKey, array $usernames);

参数：

$user：表示要跨应用管理其黑名单的用户

$appKey：表示用户所属的 appKey

$usernames：表示要从黑名单移除的用户的数组

示例：

# 跨应用把用户 'username0' 和 'username1' 从用户 'jiguang' 的黑名单列表中移除

$user = 'jiguang';
$appKey = 'xxxxxx';
$username = ['username0', 'username1'];

$response = $blacklist->remove($user, $appKey, $usernames);

跨应用批量添加黑名单

$blacklist->batchAdd($user, array $options);

参数：

$user：表示要跨应用批量管理其黑名单的用户

$options：表示跨应用批量添加黑名单的选项数组

示例：

# 跨应用把应用 ‘appKey0’ 中的用户 'username0' 和 'username1' 以及应用 ‘appKey1’ 中的用户 'username2' 和 'username3' 添加到用户 'jiguang' 的黑名单列表中

$user = 'jiguang';

$options = [
        'appKey' => 'appKey0',
        'usernames' => ['username0', 'username1']
    ],[
        'appKey' => 'appKey1',
        'usernames' => ['username2', 'username3']
];

$response = $blacklist->add($user, $options);

跨应用批量移除黑名单

$blacklist->batchRemove($user, array $options);

参数：

$user：表示要跨应用批量管理其黑名单的用户

$options：表示跨应用批量移除黑名单的选项数组

示例：

# 跨应用把应用 ‘appKey0’ 中的用户 'username0' 和 'username1' 以及应用 ‘appKey1’ 中的用户 'username2' 和 'username3' 从用户 'jiguang' 的黑名单列表中移除

$user = 'jiguang';

$options = [
        'appKey' => 'appKey0',
        'usernames' => ['username0', 'username1']
    ],[
        'appKey' => 'appKey1',
        'usernames' => ['username2', 'username3']
];

$response = $blacklist->batchRemove($user, $options);

跨应用免打扰设置

use JMessage\Cross\Nodisturb;

$nodisturb = new Nodisturb($client);

跨应用单聊免打扰设置

$nodisturb->single($user, $appKey, array $options);

参数：

$user：表示要设置跨应用单聊免打扰的用户

$appKey：表示用户所属的 appKey

$options：表示设置跨应用单聊免打扰的选项数组，支持键名 'add' 或 'remove' 表示添加或移除

示例：

$user = 'jiguang';
$appKey = 'xxxxxx';
$add = ['username0', 'username1'];
$remove = ['username2', 'username3'];
$options = ['add' => $add, 'remove' => $remove ];

# 用户 'jiguang' 跨应用对 'xxxxxx' 应用下的用户 'username0', 'username1' 添加单聊免打扰，且同时对 'username2', 'username3' 移除单聊免打扰
$response = $nodisturb->single($user, $appKey, ['add' => $add, 'remove' => $remove ]);

# 用户 'jiguang' 跨应用仅对 'xxxxxx' 应用下的用户 'username0', 'username1' 添加单聊免打扰
$response = $nodisturb->single($user, $appKey, ['add' => $add]);

# 用户 'jiguang' 跨应用仅对 'xxxxxx' 应用下的用户 'username2', 'username3' 移除单聊免打扰
$response = $nodisturb->single($user, $appKey, ['remove' => $remove ]);

跨应用群聊免打扰设置

$nodisturb->group($user, $appKey, array $options);

参数：

$user：表示要设置跨应用群聊免打扰的用户

$appKey：表示群组所属的 appKey

$options：表示设置跨应用群聊免打扰的选项数组，支持键名 'add' 或 'remove' 表示添加或移除

示例：

# 用户 'jiguang' 跨应用对 'xxxxxx' 应用下的群组 'gid0', 'gid1' 添加群聊免打扰，且同时对 'gid2', 'gid3' 移除群聊免打扰

$user = 'jiguang';
$appKey = 'xxxxxx';
$options = [
    'add' => ['gid0', 'gid1'],
    'remove' =>['gid2', 'gid3']
]
$response = $nodisturb->group($user, $appKey, $options);

跨应用好友管理

use JMessage\Cross\Friend;

$friend = new Friend($client);

跨应用添加好友

$friend->add($user, $appKey, array $friendnames);

参数：

$user：表示要跨应用管理好友的用户

$appKey：表示好友所属的 appKey

$friendnames：表示要添加的好友数组

示例：

# 用户 'jiguang' 跨应用把应用 'xxxxxx' 下的用户 'username0', 'username1' 添加为好友

$user = 'jiguang';
$appKey = 'xxxxxx';
$friendnames = ['username0', 'username1'];

$response = $friend->add($user, $appKey, $friendnames);

跨应用移除好友

$friend->remove($user, $appKey, array $friendnames);

参数：

$user：表示要跨应用管理好友的用户

$appKey：表示好友所属的 appKey

$friendnames：表示要移除的好友数组

示例：

# 用户 'jiguang' 跨应用把应用 'xxxxxx' 下的用户 'username0', 'username1' 从好友列表移除

$user = 'jiguang';
$appKey = 'xxxxxx';
$friendnames = ['username0', 'username1'];

$response = $friend->remove($user, $appKey, $friendnames);

跨应用更新好友备注

$friend->updateNotename($user, $appKey, $friendname, array $options);

参数：

$user：表示要跨应用管理好友的用户

$appKey：表示好友所属的 appKey

$friendname：表示要更新备注的好友

$options：表示跨应用更新好友备注的选项数组，支持键名 'note_name' 或 'others' 表示备注或其他备注信息

示例：

# 用户 'jiguang' 跨应用更新应用 'xxxxxx' 下的用户 'username0' 的备注为 'u00'

$user = 'jiguang';
$appKey = 'xxxxxx';
$friendname = 'username0';
$options = ['note_name' => 'u00'];

$response = $friend->updateNotename($user, $appKey, $usernames, $options);

跨应用批量更新好友备注

$friend->batchUpdateNotename($user, array $options);

参数：

$user：表示要跨应用管理好友的用户

$options：表示跨应用批量更新好友备注的选项数组

示例：

# 用户 'jiguang' 跨应用更新应用 'appKey0' 下的好友 'username0' 的备注为 'uu00'，
# 同时更新应用 'appKey1' 下的好友 'username1' 的其他备注信息为 'nothing to go'

$user = 'jiguang';

$options = [
    [
        'appKey' => 'appKey0',
        'username' => 'username0',
        'note_name' => 'uu00'
    ],[
        'appKey' => 'appKey1',
        'username' => 'username1',
        'others' => 'nothing to go'
    ]
];

$response = $friend->batchUpdateNotename($user, $options);

跨应用发送消息

use JMessage\Cross\Message;

$message = new Message($client);
# 跨应用发送文本消息
$message->sendText($version, $appKey, array $from, array $target, array $msg, array $notification = [], array $options = []);

# 跨应用发送图片消息
$message->sendImage($version, $appKey, array $from, array $target, array $msg, array $notification = [], array $options = []);

# 跨应用发送语音消息
$message->sendVoice($version, $appKey, array $from, array $target, array $msg, array $notification = [], array $options = []);

# 跨应用发送自定义消息
$message->sendCustom($version, $appKey, array $from, array $target, array $msg, array $notification = [], array $options = []);

参数：

$version: 版本号，目前是 1

$appKey: 跨应用目标appkey

$from: 发送者信息数组（说明同普通消息）

$target: 接受者信息数组（说明同同普通消息）

$msg: 消息体数组（说明同同普通消息）

$notification: 自定义通知栏展示数组（说明同同普通消息）

$options: 其他选项数组（说明同同普通消息）