README

路线图

略。。。

安装

$ composer require haixin/getui

编辑 config/surl.php

artisan vendor:publish --provider="HaiXin\GeTui\GeTuiServiceProvider"

使用

$pusher = resolve('getui');

token

$token = $pusher->getToken();

// token缓存的 key
$token->key();

// 可以更换缓存的 key
$token->key($key);

// 获取 token
$token->get(); 

// 销毁 token (请求接口销毁)
$token->destroy(); 

// 非强制的话，重新从缓存加载。缓存不存在请求接口；强制的话直接请求接口
$token->refresh($force = false); 

alias

$alias = $pusher->alias;

// 设备与别名绑定；单一绑定
$alias->bind(cid，alias));

// 设备与别名绑定；批量绑定
$alias->bind([cid => alias]);

// 根据设备查询别名
$alias->device(cid);

// 解除设备与别名的绑定关系
$alias->unbind(cid，alias);
$alias->unbind([cid => alias]);

// 解除所有与该别名绑定的设备
$alias->destroy([cid => alias]);

tags

$tags = $pusher->tags;

// 给指定设备绑定一批标签
$tags->single(cid, [tag1,tag2,tag3,...]);

// 一批设备绑定相同的一个标签
$tags->more(tag,[device1,device2,device3,...]);

// 一批设备解绑一个标签（指定设备解绑指定标签）
$tags->unbind(tag,[device1,device2,device3,...]);

user

$user = $pusher->user;

$user->count(\HaiXin\GeTui\Helper\Filter $filter);
// 查询用户信息
$user->detail(device1,device2,device3,...); 
$user->detail([device1,device2,device3,...]); 

// 查询用户状态
$user->state(device1,device2,device3,...); 
$user->state([device1,device2,device3,...]); 

// 加入黑名单
$user->black(device1,device2,device3,...); 
$user->black([device1,device2,device3,...]); 

// 移除黑名单
$user->unblack(device1,device2,device3,...); 
$user->unblack([device1,device2,device3,...]);

// 根据设备查询用户标签
$user->tags(device); 

// 设置角标
$user->badge(badge, [device1,device2,device3,...]); 

report

$report = $pusher->report;

// 根据任务编号查询任务详情
$report->task(device1,device2,device3,...); 

// 根据任务编号查询任务详情
$report->task([device1,device2,device3,...]);

// 根据任务组名查询任务详情
$report->group(group); 

// 指定日期的推送数据
$report->day('2020-01-01'); 

// 今日已推送与剩余可用推送量
$report->remainder(); 

// 指定日期用户数据
$report->user('2020-01-01'); 

// 近24小时在线用户统计
$report->online();

task

$task =$pusher->task;

// 停止任务
$task->stop(task);

// 定时任务状态
$task->state(task);

// 删除定时任务状态
$task->destroy(task);

// 指定任务下某设备的进度
$task->progress(device,task);

filter

$filter = new \HaiXin\GeTui\Helper\Filter();

// 仅支持以下 4种方式
// 'phone'=> 'phone_type',
// 'region' => 'region',
// 'portrait' => 'portrait',
// 'tag'=> 'custom_tag',
$filter->where('phone','ios')// and
 ->where('phone',['ios','android'])
 ->whereOr('phone','ios')// or
 ->whereNot('phone','ios')// not
 ->wherePhone('ios');// and

message

$message = $pusher->message();

$message->title();
$message->body();
...
$pusher->message($message);

use HaiXin\GeTui\Helper\Message;
$pusher->message(function(Message $message){
  $message->title();
  $message->body();
  ...
});

channel

$channel = $pusher->channel();

$channel->title();
$channel->body();
...
$pusher->channel($channel);

use HaiXin\GeTui\Helper\Channel;
$pusher->channel(function(Channel $channel){
  $channel->title();
  $channel->body();
  ...
});

audience

$audience = $pusher->audience();

$audience->device($device);
$pusher->audience($audience);

use HaiXin\GeTui\Helper\Audience;
$pusher->audience(function(Audience $audience){
	$audience->device($device);
  ...
});

###broadcast

$broadcast = $pusher->broadcast;

// 推送给全部用户
$broadcast->all->extras($extras)
  ->title($title)
  ->body($body)
  ->submit();
  
// 推送给指定标签的用户
$broadcast->tags->extras($extras)
  ->title($title)
  ->body($body)
  ->audience('标签','tags')
  ->submit();

// 推送给符合筛选条件的用户
$broadcast->filter->extras($extras)
  ->title($title)
  ->body($body)
  ->audience(\HaiXin\GeTui\Helper\Filter $filter)
  ->submit(); 

group

$group = $pusher->group;

// 预创建消息
$task = $group->create->title('批量推')
  ->body('批量推')
  ->extras($extras)
  ->submit(); 

// 推送给指定设备
$group->device->audience([device1,device2,device3])
  ->task(task)
  ->submit(); 

// 推送给指定别名
group->alias->audience([device1,device2,device3])
  ->task(task)
  ->submit(); 

single

$single = $pusher->single;

// 根据设备单推
$single->device->audience->device(device)
  ->title(title)
  ->body(body)
  ->extras(extras)
  ->submit(); 

// 根据别名单推
$single->alias->audience->device(device)
  ->title(title)
  ->body(body)
  ->extras(extras)
  ->submit(); 

pipeline

$pipeline = $pusher->pipeline;

// 批量单推给设备
$device = $pipeline->device;
for($index = 0; $index <= 100; ++$index){
$device->audience(device)
 ->title("title{$index}")
 ->body("body{$index}")
 ->delay();
}
$device->submit(); 

// 批量单推给别名
$alias = $pipeline->alias;
for($index = 0; $index <= 100; ++$index){
$alias->audience(alias)
 ->title("title{$index}")
 ->body("body{$index}")
 ->delay();
}
$alias->submit(); 

更新日志

更新日志