Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addCustomAttribute(String, String) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Adds a custom attributes to the notification.
- ANDROID - Enum constant in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerPlatformNames
-
The PlatformType is ANDROID
- awaitSendTermination() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServer
-
Wait for all submitted notifications to be sent.
- awaitSendTerminationAndFinish() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServer
-
Wait for all submitted notifications to be sent.
C
- CALL_ON_TERMINATED_INSTANCE - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The NotificationSDKServer instance has been finished.
- com.vasco.digipass.sdk.utils.notification.server - package com.vasco.digipass.sdk.utils.notification.server
- com.vasco.digipass.sdk.utils.notification.server.constants - package com.vasco.digipass.sdk.utils.notification.server.constants
- com.vasco.digipass.sdk.utils.notification.server.exceptions - package com.vasco.digipass.sdk.utils.notification.server.exceptions
- CREDENTIALS_ANDROID_INVALID - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The Android part of the credentials object is invalid.
- CREDENTIALS_IOS_INVALID - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The iOS part of the credentials object is invalid.
- CREDENTIALS_NULL - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The credentials object is null.
D
- DEFAULT_CONNECTION_TIMEOUT - Static variable in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Default timeout (in milliseconds) after which a sending connection should be closed.
- DEFAULT_PROXY_TYPE - Static variable in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Default proxy type
- DEFAULT_SOCKS_PROXY_PORT - Static variable in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Default SOCKS proxy port
- DEFAULT_TERMINATE_TIMEOUT - Static variable in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Default timeout (in milliseconds) when
NotificationSDKServer.awaitSendTerminationAndFinish()
is called. - DEFAULT_THREAD_MAX_NUMBER - Static variable in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Default maximum number of threads allowed to run for sending push messages.
G
- getAndroidFirebaseServiceAccountJson() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the path to the Firebase service account JSON configuration file to be used during the communication with the server.
- getAndroidFirebaseServiceAccountJsonBytes() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the bytes of the Firebase service account JSON configuration file to be used during the communication with the server.
- getAndroidFirebaseServiceAccountJsonStream() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the input stream of the Firebase service account JSON configuration file to be used during the communication with the server.
- getAndroidProjectKey() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Deprecated.
- getApnsServerMockConfiguration() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Gets the APNs server mock configuration.
- getConnectionTimeout() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Gets the timeout (in milliseconds) after which a sending connection should be closed.
- getContent() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Gets the content of the notification.
- getCustomAttributes() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Gets the tracking identifier used to differentiate the notifications in the error/success callbacks.
- getErrorCode() - Method in exception com.vasco.digipass.sdk.utils.notification.server.exceptions.NotificationSDKServerException
-
Retrieves the error code of the
NotificationSDKServerException
. - getIdentifier() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Gets the notification identifier of the notification.
- getIOSBadge() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
(iOS only).
- getiOSBundleId() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
(iOS only).
- getiOSKeyId() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the ID of the key
- getiOSP12CertificatePassword() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the password of the p12 file
- getiOSP12CertificatePath() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the path to the p12 file containing the certificate to be used for the authentication with the server
- getiOSP12CertificateStream() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the stream to the p12 file containing the certificate to be used for the authentication with the server
- getiOSP8KeyPath() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the path to the p8 file containing the key to be used for the authentication with the server
- getiOSP8KeyStream() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the stream to the p8 file containing the key to be used for the authentication with the server
- getiOSTeamId() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the ID of the team
- getPayloadLength(Notification, NotificationSDKServerPlatformNames) - Static method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServer
-
Gets the notification payload length, in bytes, depending on the given platform name.
- getPlatformName(String) - Static method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServer
-
Gets the platform name from a VASCONotificationIdentifier identified by its hexadecimal representation.
- getPriority() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Gets the priority of the notification.
- getProxyHostname() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Gets the configured proxy hostname.
- getProxyPassword() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Gets the password used to authenticate to the proxy server.
- getProxyPort() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Gets the configured proxy port.
- getProxyType() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Gets the configured proxy type.
- getProxyUsername() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Gets the username used to authenticate to the proxy server.
- getSubject() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Gets the subject of the notification.
- getTerminateTimeout() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Gets the maximum time to wait (in milliseconds) when awaitSendTermination is called.
- getThreadMaxNumber() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Gets the maximum number of threads allowed to run for sending push messages.
- getTimeToLive() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Gets the time to live of the notification.
- getTitle() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Gets the title of the notification.
- getTrackingIdentifier() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Gets the tracking identifier used to differentiate the notifications in the error/success callbacks.
H
- HTTP - Enum constant in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerProxyTypes
-
Indicates that a HTTP proxy is used
I
- INTERNAL_ERROR - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
An internal error has occurred.
- IOS - Enum constant in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerPlatformNames
-
The PlatformType is IOS
- isAndroidDryRun() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
(Android only).
- isAndroidHeadsUp() - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
(Android only).
M
- MAX_PAYLOAD_LENGTH_ANDROID - Static variable in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServer
-
Maximum length, in bytes, of the notification payload for Android as described by the Google Cloud Messaging (GCM) specifications.
- MAX_PAYLOAD_LENGTH_IOS - Static variable in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServer
-
Maximum length, in bytes, of the notification payload for iOS as described by the Apple Push Notification Service (APNS) specifications.
N
- NO_PROXY - Enum constant in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerProxyTypes
-
No proxy is used, this is the default value
- Notification - Class in com.vasco.digipass.sdk.utils.notification.server
-
The Notification object contains all the elements (title, subject...) to build a notification ready to be sent to the user device.
- Notification(String, String, String) - Constructor for class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Creates a
Notification
object from its mandatory attributes. - Notification(String, String, String, boolean) - Constructor for class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Creates a
Notification
object from its mandatory attributes. - NOTIFICATION_ANDROID_DATA_TOO_LONG - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The Android data of the notification is too long (the maximum length of the payload is
NotificationSDKServer.MAX_PAYLOAD_LENGTH_ANDROID
bytes). - NOTIFICATION_CONTENT_NULL - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The notification content is null.
- NOTIFICATION_IOS_DATA_TOO_LONG - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The iOS data of the notification is too long (the maximum length of the payload is
NotificationSDKServer.MAX_PAYLOAD_LENGTH_IOS
bytes). - NOTIFICATION_IOS_NO_APP_BUNDLE_ID - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The iOS bundle ID has not been specified in the notification.
- NOTIFICATION_IOS_TITLE_CHARACTER_INVALID - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The iOS title of the notification contains an invalid character.
- NOTIFICATION_IOS_TOKEN_INVALID - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The iOS device token is no longer valid.
- NOTIFICATION_NULL - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The notification object is null.
- NOTIFICATION_PROVIDER_ANDROID_ERROR - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
There has been an error with the Google notification service provider.
- NOTIFICATION_PROVIDER_IOS_ERROR - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
There has been an error with the Apple notification service provider.
- NOTIFICATION_SUBJECT_NULL - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The notification subject is null.
- NOTIFICATION_TITLE_NULL - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The notification title is null.
- NotificationSDKServer - Class in com.vasco.digipass.sdk.utils.notification.server
-
Provides the entry points for the NotificationSDKServer library:
NotificationSDKServer(NotificationSDKServerCredentials, NotificationSDKServerSettings, NotificationSDKServerCallbacks)
: contructs the server object;NotificationSDKServer.sendNotification(String, Notification)
: sends a notification to a specific user device;NotificationSDKServer.awaitSendTerminationAndFinish()
: closes remaining tasks according to the object's settings and eventually closes existing connections;NotificationSDKServer.getPayloadLength(Notification, NotificationSDKServerPlatformNames)
: gets the payload length for a specific notification and platform;NotificationSDKServer.getPlatformName(String)
: gets the platform name of a specific user device (NotificationSDKServerPlatformNames
). - NotificationSDKServer(NotificationSDKServerCredentials, NotificationSDKServerSettings, NotificationSDKServerCallbacks) - Constructor for class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServer
-
Constructs a NotificationSDKServer object.
- NotificationSDKServerCallbacks - Interface in com.vasco.digipass.sdk.utils.notification.server
-
Callbacks to be implemented when sending a notification.
- NotificationSDKServerCredentials - Class in com.vasco.digipass.sdk.utils.notification.server
-
The NotificationSDKServerCredentials object encompasses the customer's credentials necessary to log in to each platform specific push notification services.
- NotificationSDKServerCredentials() - Constructor for class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Creates a
NotificationSDKServerCredentials
object. - NotificationSDKServerErrorCodes - Class in com.vasco.digipass.sdk.utils.notification.server.constants
-
Defines the error codes returned by the NotificationSDKServer.
- NotificationSDKServerException - Exception in com.vasco.digipass.sdk.utils.notification.server.exceptions
-
This exception is thrown when a problem occurs while using NotificationSDKServer.
- NotificationSDKServerException(int) - Constructor for exception com.vasco.digipass.sdk.utils.notification.server.exceptions.NotificationSDKServerException
-
Constructs a new
NotificationSDKServerException
. - NotificationSDKServerException(int, Throwable) - Constructor for exception com.vasco.digipass.sdk.utils.notification.server.exceptions.NotificationSDKServerException
-
Constructs a new
NotificationSDKServerException
. - NotificationSDKServerPlatformNames - Enum Class in com.vasco.digipass.sdk.utils.notification.server.constants
-
NotificationSDKServerPlatformNames indicates the common device platform name.
- NotificationSDKServerProxyTypes - Enum Class in com.vasco.digipass.sdk.utils.notification.server.constants
-
Indicates the proxy type to use.
- NotificationSDKServerSettings - Class in com.vasco.digipass.sdk.utils.notification.server
-
The NotificationSDKServerSettings object encompasses the NotificationSDKServer object's specific settings.
- NotificationSDKServerSettings() - Constructor for class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Creates a
NotificationSDKServerSettings
object.
O
- onSendNotificationError(int, String, NotificationSDKServerException) - Method in interface com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCallbacks
-
Callback called in case of error while sending a notification
- onSendNotificationSuccess(int, String) - Method in interface com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCallbacks
-
Callback called in case of success while sending a notification
S
- sendNotification(String, Notification) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServer
-
Sends a notification, described by a Notification object, using the specified client device identifier.
- setAndroidDryRun(boolean) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
(Android only).
- setAndroidFirebaseServiceAccountJson(String) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Sets the Firebase service account JSON configuration file for the Android specific notification service.
- setAndroidFirebaseServiceAccountJsonBytes(byte[]) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Sets the Firebase service account JSON configuration bytes for the Android specific notification service.
- setAndroidFirebaseServiceAccountJsonStream(InputStream) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Sets the Firebase service account JSON configuration stream for the Android specific notification service.
- setAndroidHeadsUp(boolean) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
(Android only).
- setAndroidPlatformCredentials(String) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Deprecated.
- setApnsServerMockConfiguration(ApnsServerMockConfiguration) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Sets the APNs server mock configuration.
- setConnectionTimeout(int) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Sets the timeout (in milliseconds) after which a sending connection should be closed.
- setContent(String) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Sets the content of the notification.
- setIdentifier(int) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Sets the notification identifier of the notification.
- setIOSBadge(int) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
(iOS only).
- setiOSBundleId(String) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
(iOS only).
- setiOSPlatformCredentials(boolean, InputStream, String) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Sets the credentials for the certificate-based authentication on the iOS platform.
- setiOSPlatformCredentials(boolean, InputStream, String, String) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Sets the credentials for the token-based authentication on the iOS platform.
- setiOSPlatformCredentials(boolean, String, String) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Sets the credentials for the certificate-based authentication on the iOS platform.
- setiOSPlatformCredentials(boolean, String, String, String) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Sets the credentials for the token-based authentication on the iOS platform.
- setProxy(NotificationSDKServerProxyTypes, String, int, String, String) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Sets the proxy settings if required by your organization.
- setSubject(String) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Sets the subject of the notification.
- setTerminateTimeout(int) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Sets the maximum time to wait (in milliseconds) when awaitSendTermination is called.
- setThreadMaxNumber(int) - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerSettings
-
Sets the maximum number of threads allowed to run for sending push messages.
- setTimeToLive(Date) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Sets the time to live of the notification.
- SETTINGS_INVALID - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The settings object is invalid.
- setTitle(String) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Sets the title of the notification.
- setTrackingIdentifier(int) - Method in class com.vasco.digipass.sdk.utils.notification.server.Notification
-
Sets the tracking identifier used to differentiate the notifications in the error/success callbacks.
- SOCKS - Enum constant in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerProxyTypes
-
Indicates that a SOCKS proxy is used
T
- toString() - Method in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerPlatformNames
- toString() - Method in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerProxyTypes
U
- UNKNOWN - Enum constant in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerPlatformNames
-
The device platform is not known by the NotificationSDKServer
- usesiOSDevelopmentServer() - Method in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServerCredentials
-
Gets the status of the server to be used.
V
- valueOf(String) - Static method in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerPlatformNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerProxyTypes
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerPlatformNames
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerProxyTypes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VASCO_NOTIFICATION_IDENTIFIER_INCORRECT_FORMAT - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The notification format is incorrect.
- VASCO_NOTIFICATION_IDENTIFIER_INVALID - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The notification identifier is invalid.
- VASCO_NOTIFICATION_IDENTIFIER_NULL - Static variable in class com.vasco.digipass.sdk.utils.notification.server.constants.NotificationSDKServerErrorCodes
-
The notification identifier is null or empty.
- VERSION - Static variable in class com.vasco.digipass.sdk.utils.notification.server.NotificationSDKServer
-
NotificationSDKServer library version
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
NotificationSDKServerCredentials.getAndroidFirebaseServiceAccountJson()
instead.