README

PHP 包装器用于 Pushover 通知 API

安装

要开始使用，请通过以下命令将包添加到您的项目中

composer require fernleafsystems/apiwrappers-pushover

当前版本 0.1.x 为测试版。请使用严格的 Composer 版本。

入门

目前仅实现了 API 的两个主要部分

用户/组验证
消息发送（推送）

1) 用户/组验证

对于所有 API 请求，首先要做的是创建一个新的 API 连接。

验证用户或组

	use FernleafSystems\ApiWrappers\Pushover;
	
	$oConnection = ( new Pushover\Connection() )
			->setApiKey( 'your api key' );
			
	$bSuccess = ( new Pushover\User\Verify() )
		->setConnection( $oConn )
		->setUserGroupKey( 'user or group key' )
		->verify();

2) 使用更改的 Key 进行用户/组验证

要执行对 API 的操作，您需要发送一个访问令牌——而不是在前一个阶段获得的 OAuth 代码。为了获取这个令牌，您的应用程序将发送一个请求新令牌的请求，它将看起来像这样

3) 发送消息

	use FernleafSystems\ApiWrappers\Pushover;

	$bSuccess = ( new Pushover\Message\Push() )
		->setConnection( $oConn )
		->setUserGroupKey( 'user or group key' )
		->setTitle( 'My lovely title' )
		->setMessage( 'An important message' )
		->setIsHtml( false )
		->push();

发送消息非常简单。提供标题和消息，并根据 API 调整消息的其他任何参数。

4) 发送到特定设备。

	$bSuccess = ( new Pushover\Message\Push() )
		->setDevice( 'Device Key' )
		...
		->push();

所有当前的 API 类都允许您指定一个可选的设备。如果省略，则使用所有设备。

在验证的情况下，如果省略，则验证用户至少有 1 个活动设备。

错误和异常

在检索、创建和更新时，会对数据进行一些基本检查，以确保在发送请求之前提供绝对的最小值。如果这些检查失败，则会抛出异常。

如果这些检查没有失败，并且请求失败，您有几种选择。这可能会在未来改变，因为当前的实现有缺陷，并不令人满意。

如果您发现错误、改进建议等，请告知我们。

fernleafsystems / apiwrappers-pushover

维护者

详情