Provides the entry points for the NotificationSDKServer library:
- Version
- 4.31.0
◆ NotificationSDKServer() [1/2]
◆ NotificationSDKServer() [2/2]
Constructs a NotificationSDKServer object with the credentials in input.
- Parameters
-
- Exceptions
-
NotificationSDKServerException | Exception containing an error code and a message. Available error codes are:
|
◆ AwaitSendTerminationAndFinish()
void AwaitSendTerminationAndFinish |
( |
| ) |
|
|
inline |
Wait for all submitted notifications to be sent.
The last notifications that have not been sent after a specific timeout (which is specified in the NotificationSDKServerSettings object of the NotificationSDKServer object) will be cancelled.
All connections are closed. The object is not usable anymore and thus can't be used to send notifications.
- Exceptions
-
NotificationSDKServerException | Exception containing an error code and a message. Available error codes are:
|
◆ GetIOSInactiveDevices()
Dictionary<string, DateTime> GetIOSInactiveDevices |
( |
| ) |
|
|
inline |
Returns the list of devices that reported failed-delivery attempts to the Apple Feedback services. The result is a map, containing the notification identifier mapped to the timestamp when APNs determined that the application no longer exists on the device.
- Returns
- The map containing a notification identifier and a timestamp
- Exceptions
-
NotificationSDKServerException | Exception containing an error code and a message. Available error codes are:
|
◆ GetPayloadLength()
Gets the notification payload length, in bytes, depending on the given platform name. For all platforms, the payload is encoded in UTF-8 before its length calculation. Therefore, a non-latin character (Cyrillic, Japanese, Arabic, etc.) will have a length greater than 1.
Please note that each protocol adds some overhead. The usable length is thus smaller than the theoretical maximum payload length.
- Parameters
-
notification | Notification containing a title, subject... |
platformName | The platform name. |
- Returns
- The notification payload length in bytes.
- Exceptions
-
NotificationSDKServerException | Exception containing an error code and a message. Available error codes are:
|
◆ GetPlatformName()
Gets the platform name from a VASCONotificationIdentifier identified by its hexadecimal representation.
- Parameters
-
vascoNotificationIdentifier | Hexadecimal representation of the VASCO notification identifier. |
- Returns
- the platform name of VASCO Notification Identifier (see NotificationSDKServerPlatformNames).
- Exceptions
-
NotificationSDKServerException | Exception containing an error code and a message. Available error codes are:
|
◆ SendNotification()
void SendNotification |
( |
string |
vascoNotificationIdentifier, |
|
|
Notification |
notification |
|
) |
| |
|
inline |
Sends a notification, described by a Notification object, using the specified client device identifier.
As the process of sending a notification is asynchronous, a callback is necessary in order to handle errors or to report success.
- Parameters
-
vascoNotificationIdentifier | The VASCO Notification Identifier provided by the client. String, cannot be null or empty. |
notification | Notification that must be sent to the device (check Notification). |
- Exceptions
-
NotificationSDKServerException | Exception containing an error code and a message. Available error codes are:
|
◆ MAX_PAYLOAD_LENGTH_ANDROID
const int MAX_PAYLOAD_LENGTH_ANDROID = 4096 |
|
static |
Maximum length, in bytes, of the notification payload for Android as described by the Google Cloud Messaging (GCM) specifications.
◆ MAX_PAYLOAD_LENGTH_IOS
const int MAX_PAYLOAD_LENGTH_IOS = 2048 |
|
static |
Maximum length, in bytes, of the notification payload for iOS as described by the Apple Push Notification Service (APNS) specifications.
◆ VERSION
const string VERSION = "4.31.0" |
|
static |
◆ OnSendNotificationError
◆ OnSendNotificationSuccess
The documentation for this class was generated from the following file: