Notification SDK Server  4.34.0
The Notification SDK Server provides a library to send notification to various devices (iOS and Android)
NotificationSDKServerCredentials Class Reference

The NotificationSDKServerCredentials object encompasses the customer's credentials necessary to log in to each platform specific push notification services.
It must be provided to the NotificationSDKServer constructor. More...

Public Member Functions

 NotificationSDKServerCredentials ()
 Creates a NotificationSDKServerCredentials object.
The platform specific attributes must be set using the dedicated methods. More...
 
void SetAndroidFirebaseServiceAccountJson (string firebaseServiceAccountJson)
 Sets the Firebase service account JSON configuration file for the Android specific notification service.It is retrieved from the Google Firebase Console. More...
 
void SetAndroidFirebaseServiceAccountJsonStream (Stream firebaseServiceAccountJsonStream)
 Sets the Firebase service account JSON configuration file input stream to be used during the communication with the server. It is retrieved from the Google Firebase Console. More...
 
void SetAndroidFirebaseServiceAccountJsonBytes (byte[] firebaseServiceAccountJsonBytes)
 Sets the firebase service account JSON configuration file bytes to be used during the communication with the server.It is retrieved from the Google Firebase Console. More...
 
void SetIOSPlatformCredentials (bool useSandboxGateway, string p8CertificatePath, string keyID, string teamID, string bundleID)
 Sets the credentials for the iOS specific notification service using a P8 token. More...
 

Properties

string AndroidFirebaseServiceAccountJson [get]
 Firebase service account JSON configuration file for the Android specific notification service.It is retrieved from the Google Firebase Console. More...
 
Stream AndroidFirebaseServiceAccountJsonStream [get]
 Firebase service account JSON configuration file input stream to be used during the communication with the server.It is retrieved from the Google Firebase Console. More...
 
byte[] AndroidFirebaseServiceAccountJsonBytes [get]
 Firebase service account JSON configuration file bytes to be used during the communication with the server. It is retrieved from the Google Firebase Console. Expected encoding is UTF-16. More...
 
bool IOSUseSandboxGateway [get]
 Status of the gateway to be used. The sandbox gateway must be used for application development. More...
 
string IOSP8CertificatePath [get]
 Path of the P8 certificate to be used for the communication with the server. More...
 
string IOSKeyID [get]
 Key ID related to the P8 certificate.
Ex: 8Z9JNM2MG8 More...
 
string IOSTeamID [get]
 Apple Team ID.
Ex: PS856PAVJ3 More...
 
string IOSBundleID [get]
 Apple targeted bundle ID.
Ex: com.mycompany.myapp More...
 
bool WPconfigured [get]
 WP configured. More...
 

Detailed Description

The NotificationSDKServerCredentials object encompasses the customer's credentials necessary to log in to each platform specific push notification services.
It must be provided to the NotificationSDKServer constructor.

Constructor & Destructor Documentation

◆ NotificationSDKServerCredentials()

Creates a NotificationSDKServerCredentials object.
The platform specific attributes must be set using the dedicated methods.

Member Function Documentation

◆ SetAndroidFirebaseServiceAccountJson()

void SetAndroidFirebaseServiceAccountJson ( string  firebaseServiceAccountJson)
inline

Sets the Firebase service account JSON configuration file for the Android specific notification service.It is retrieved from the Google Firebase Console.

Parameters
firebaseServiceAccountJson

◆ SetAndroidFirebaseServiceAccountJsonBytes()

void SetAndroidFirebaseServiceAccountJsonBytes ( byte[]  firebaseServiceAccountJsonBytes)
inline

Sets the firebase service account JSON configuration file bytes to be used during the communication with the server.It is retrieved from the Google Firebase Console.

Parameters
firebaseServiceAccountJsonBytesthe bytes containing the Firebase service account JSON configuration file in UTF-16 encoding

◆ SetAndroidFirebaseServiceAccountJsonStream()

void SetAndroidFirebaseServiceAccountJsonStream ( Stream  firebaseServiceAccountJsonStream)
inline

Sets the Firebase service account JSON configuration file input stream to be used during the communication with the server. It is retrieved from the Google Firebase Console.

Parameters
firebaseServiceAccountJsonStreamthe input stream of the Firebase service account JSON configuration file to be used during the communication with the server

◆ SetIOSPlatformCredentials()

void SetIOSPlatformCredentials ( bool  useSandboxGateway,
string  p8CertificatePath,
string  keyID,
string  teamID,
string  bundleID 
)
inline

Sets the credentials for the iOS specific notification service using a P8 token.

Parameters
useSandboxGatewaySpecify if the sandbox gateway must be used.
p8CertificatePathThe path to the p8 token to be used for the communication with the server.
keyIDKey ID related to the P8 certificate.
Ex: 8Z9JNM2MG8
teamIDApple Team ID.
Ex: PS856PAVJ3
bundleIDApple targeted bundle ID.
Ex: com.mycompany.myapp

Property Documentation

◆ AndroidFirebaseServiceAccountJson

string AndroidFirebaseServiceAccountJson
get

Firebase service account JSON configuration file for the Android specific notification service.It is retrieved from the Google Firebase Console.

◆ AndroidFirebaseServiceAccountJsonBytes

byte [] AndroidFirebaseServiceAccountJsonBytes
get

Firebase service account JSON configuration file bytes to be used during the communication with the server. It is retrieved from the Google Firebase Console. Expected encoding is UTF-16.

◆ AndroidFirebaseServiceAccountJsonStream

Stream AndroidFirebaseServiceAccountJsonStream
get

Firebase service account JSON configuration file input stream to be used during the communication with the server.It is retrieved from the Google Firebase Console.

◆ IOSBundleID

string IOSBundleID
get

Apple targeted bundle ID.
Ex: com.mycompany.myapp

◆ IOSKeyID

string IOSKeyID
get

Key ID related to the P8 certificate.
Ex: 8Z9JNM2MG8

◆ IOSP8CertificatePath

string IOSP8CertificatePath
get

Path of the P8 certificate to be used for the communication with the server.

◆ IOSTeamID

string IOSTeamID
get

Apple Team ID.
Ex: PS856PAVJ3

◆ IOSUseSandboxGateway

bool IOSUseSandboxGateway
get

Status of the gateway to be used. The sandbox gateway must be used for application development.

◆ WPconfigured

bool WPconfigured
get

WP configured.


The documentation for this class was generated from the following file: