Overview

Namespaces

  • NNV
    • OneSignal
      • API
      • Constants
      • Utils

Classes

  • App
  • Notification
  • Player
  • Overview
  • Namespace
  • Class

Class Notification

Notification API

Namespace: NNV\OneSignal\API
Located at API/Notification.php
Methods summary
public
# __construct( NNV\OneSignal\OneSignal $oneSignal, string $appIDKey = null, string $restAPIKey = null )

Parameters

$oneSignal
OneSignal instance
$appIDKey
Application ID
$restAPIKey
API Key for REST JSON API
public NNV\OneSignal\OneSignal::execute()
# create( array $notificationData )

Sends notifications to users

Sends notifications to users

Parameters

$notificationData
Notification data

Returns

NNV\OneSignal\OneSignal::execute()
public NNV\OneSignal\OneSignal::execute()
# cancel( string $notificationID )

Stop a scheduled or currently outgoing notification

Stop a scheduled or currently outgoing notification

Parameters

$notificationID
Notification ID

Returns

NNV\OneSignal\OneSignal::execute()
public NNV\OneSignal\OneSignal::execute()
# get( string $notificationID )

View the details of a single notification

View the details of a single notification

Parameters

$notificationID
Notification ID

Returns

NNV\OneSignal\OneSignal::execute()
public NNV\OneSignal\OneSignal::execute()
# all( integer $limit = 10, integer $offset = 0 )

View the details of multiple notifications

View the details of multiple notifications

Parameters

$limit
How many notifications to return.
$offset
Result offset. Result are sorted by queued_at

Returns

NNV\OneSignal\OneSignal::execute()
public NNV\OneSignal\OneSignal::execute()
# trackOpen( string $notificationID )

Track when users open a notification

Track when users open a notification

Parameters

$notificationID
Notification ID

Returns

NNV\OneSignal\OneSignal::execute()
API documentation generated by ApiGen