Overview

Namespaces

  • NNV
    • OneSignal
      • API
      • Constants
      • Utils

Classes

  • OneSignal
  • Overview
  • Namespace
  • Class

Class OneSignal

OneSignal API

Namespace: NNV\OneSignal
Located at OneSignal.php
Methods summary
public
# __construct( string $userAuthKey, string $appIDKey = null, string $restAPIKey = null, array $options = [] )

Parameters

$userAuthKey
User auth key
$appIDKey
App ID key
$restAPIKey
REST API key
$options
Extra options for GuzzleHttp Client
public string
# getAPIBaseURI( )

Get API base URI

Get API base URI

Returns

string
API base URI
public string
# getUserAuth( )

Get user auth key

Get user auth key

Returns

string
User auth key
public NNV\OneSignal\OneSignal
# setAppIDKey( string $appIDKey )

Set app ID key

Set app ID key

Parameters

$appIDKey
App ID key

Returns

NNV\OneSignal\OneSignal
public string
# getAppIDKey( )

Get App ID key

Get App ID key

Returns

string
App ID key
public NNV\OneSignal\OneSignal
# setRESTAPIKey( string $restAPIKey )

Set REST API key

Set REST API key

Parameters

$restAPIKey
REST API key

Returns

NNV\OneSignal\OneSignal
public string
# getRESTAPIKey( )

Get REST API key

Get REST API key

Returns

string
API Key for JSON API
public array
# getGuzzleOptions( )

Get Guzzle extra options

Get Guzzle extra options

Returns

array
Guzzle extra options
public object
# execute( string $url, string $method, array $options = [] )

Execute call API

Execute call API

Parameters

$url
URL to call
$method
Method to call
$options
Extra options for GuzzleHttp Client

Returns

object
Object contain response detail
public object
# getResponseContent( GuzzleHttp\Psr7\Response $response )

Get detail response

Get detail response

Parameters

$response
Response from GuzzleHttp Client

Returns

object
Response detail
public NNV\OneSignal\OneSignal
# copy( string $userAuthKey = null, string $appIDKey = null, string $restAPIKey = null, array $options = [] )

Create new OneSignal instace

Create new OneSignal instace

Parameters

$userAuthKey
User auth key
$appIDKey
App ID key
$restAPIKey
REST API key
$options
Extra options for GuzzleHttp Client

Returns

NNV\OneSignal\OneSignal
New OneSignal instance
API documentation generated by ApiGen