PHP Класс OneSignal\Devices

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$api

Открытые методы

Метод Описание
__construct ( OneSignal $api )
add ( array $data ) : array Register a device for your application.
csvExport ( array $extraFields = [] ) : array Export all information about devices in a CSV format for your application.
getAll ( integer $limit = self::DEVICES_LIMIT, integer $offset ) : array Get information about all registered devices for your application.
getOne ( string $id ) : array Get information about device with provided ID.
onFocus ( string $id, array $data ) : array Increment the device's total session length.
onPurchase ( string $id, array $data ) : array Track a new purchase.
onSession ( string $id, array $data ) : array Call on new device session in your app.
update ( string $id, array $data ) : array Update existing registered device for your application with provided data.

Защищенные методы

Метод Описание
resolve ( array $data, callable $callback = null )

Описание методов

__construct() публичный Метод

public __construct ( OneSignal $api )
$api OneSignal

add() публичный Метод

Register a device for your application.
public add ( array $data ) : array
$data array Device data
Результат array

csvExport() публичный Метод

Application auth key must be set.
public csvExport ( array $extraFields = [] ) : array
$extraFields array Additional fields that you wish to include. Currently supports: "location", "rooted"
Результат array

getAll() публичный Метод

Application auth key must be set.
public getAll ( integer $limit = self::DEVICES_LIMIT, integer $offset ) : array
$limit integer Results offset (results are sorted by ID)
$offset integer How many devices to return (max 300)
Результат array

getOne() публичный Метод

Get information about device with provided ID.
public getOne ( string $id ) : array
$id string Device ID
Результат array

onFocus() публичный Метод

Increment the device's total session length.
public onFocus ( string $id, array $data ) : array
$id string Device ID
$data array Device data
Результат array

onPurchase() публичный Метод

Track a new purchase.
public onPurchase ( string $id, array $data ) : array
$id string Device ID
$data array Device data
Результат array

onSession() публичный Метод

Call on new device session in your app.
public onSession ( string $id, array $data ) : array
$id string Device ID
$data array Device data
Результат array

resolve() защищенный Метод

protected resolve ( array $data, callable $callback = null )
$data array
$callback callable

update() публичный Метод

Update existing registered device for your application with provided data.
public update ( string $id, array $data ) : array
$id string Device ID
$data array New device data
Результат array

Описание свойств

$api защищенное свойство

protected $api