README

一个库，可以与Redhat Aerogear统一推送的RESTful API集成。

安装

Composer

$ composer require napp/aerogear-push

Keycloak oauth令牌使用

所有方法（除SenderPushRequest()外）都有OAuthToken依赖，生成令牌请参阅examples/oauth-keycloak.md

设置令牌的示例。

$request->setOauthToken($token);

使用方法

如何使用此库的示例。

<?php

use Napp\AeroGearPush;
use Napp\AeroGearPush\Request;
use Napp\AeroGearPush\Exception;

$client = new AeroGearPush('https://host.com/ag-push/rest/');

$request = new SenderPushRequest();
$request
->setAuth('PushApplicationID', 'MasterSecret')
->setMessage(
  [
    'sound' => 'default',
    'alert' => 'this is a message.',
  ]
)
->setCriteria(
  [
    'alias' => ['my-alias'],
  ]
);

try {
  $response = $client->SenderPush($request);
  var_dump($response);
} catch (AeroGearPushException $e) {
  die($e->getMessage());
}

可用的请求/响应方法。

有关如何格式化接受数组的方法的详细信息，请参阅AeroGear统一推送API文档。

CreateApplicationRequest()

必需方法

setOauthToken() # oAuth令牌 setName() # 字符串

可选方法

setDeveloper() # 字符串 setDescription() # 字符串

响应

响应由createApplication($request)处理

返回类型

json

UpdateApplicationRequest()

必需方法

setOauthToken() # oAuth令牌 setName() # 字符串

可选方法

setDeveloper() # 字符串 setDescription() # 字符串

响应

响应由createApplication()处理

返回类型

json

DeleteApplicationRequest($pushAppId)

必需方法

setOauthToken() # oAuth令牌

可选方法

响应

响应由deleteApplication()处理

返回类型

json

CreateIosVariantRequest($pushAppId)

必需方法

setOauthToken() # oAuth令牌 setCertificate() # fopen文件资源 setPassphrase() # 字符串 setProduction() # 字符串 ('true'或'false')

可选方法

setName() # 字符串 setDescription() # 字符串 setDeveloper() # 字符串

响应

响应由createIosVariant($request)处理

返回类型

json

CreateSimplePushVariantRequest($pushAppId)

必需方法

setOauthToken() # oAuth令牌

可选方法

setName() # 字符串 setDescription() # 字符串 setDeveloper() # 字符串 setProjectNumber() # 字符串

响应

响应由createSimplePushVariant()处理

返回类型

json

CreateAndroidVariantRequest($pushAppId)

必需方法

setOauthToken() # oAuth令牌 setGoogleKey() # 字符串

可选方法

setName() # 字符串 setDescription() # 字符串 setDeveloper() # 字符串 setProjectNumber() # 字符串

响应

响应由createAndroidVariant()处理

返回类型

json

SenderPushRequest()

AeroGear统一推送文档

必需方法

setAuth(pushApplicationId, masterSecret) setMessage() # 数组 setCriteria() # 数组

可选方法

setConfig() # 数组

响应

响应由senderPush()处理

返回类型

json

GetApplicationInstallationRequest()

必需方法

setOauthToken() # oAuth令牌 setVariantId() # 字符串

可选方法

setInstallationId() # 字符串

响应

响应由getApplicationInstallation()处理

返回类型

json

GetApplicationRequest()

必需方法

setOauthToken() # oAuth令牌

可选方法

setPageNumber() # 整数 setPerPage() # 整数 enableDeviceCount() enableActivity()

响应

响应由getApplication()处理

返回类型

json

GetMetricsMessagesRequest()

必需方法

setOauthToken() # oAuth令牌

可选方法

setPageNumber() # 整数 setPerPage() # 整数

响应

响应由metricsMessages()处理

返回类型

json

GetMetricsDashboardRequest()

必需方法

setOauthToken() # oAuth令牌

可选方法

setType() # 字符串 {active, warnings}

响应

响应由metricsDashboard()处理

返回类型

json

GetSysInfoHealthRequest()

必需方法

setOauthToken() # oAuth令牌

可选方法

响应

响应由sysInfoHealth()处理

返回类型

json

变更日志

• 1.0.2

  • 添加了设备令牌的批量导入
  • 修复：拼写错误

• 1.0.1

  • 修复了AbstractApplicationRequest的错误大小写

• 1.0

  • 初始化

许可

MIT，见LICENSE。