com.codename1.push

Class Push

java.lang.Object

com.codename1.push.Push

public class Push
extends Object

Utility class for sending a push message to a different device through the Codename One push servers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GOOGLE_PUSH_KEY Key for the hashtable argument when pushing to the google play store

Constructor Summary

Constructors

Constructor and Description
Push(String token, String body, String... deviceKeys) Creates a new push notification.

Method Summary

Modifier and Type	Method and Description
Push	apnsAuth(String iosCertificateURL, String iosCertificatePassword, boolean production) Sets authentication for APNS (iOS)
Push	gcmAuth(String googleAuthKey) Sets authentication for GMS (Android and Chrome)
static String	getDeviceKey() Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to getPushKey()
static String	getPushKey() Returns the push device key if the device was previously successfully registered for push otherwise returns null
Push	pushType(int pushType) Sets the type of push to use.
boolean	send() Sends push message.
void	sendAsync() Sends push message asynchronously.
static boolean	sendPushMessage(String body, String deviceKey, boolean production, String googleAuthKey, String iosCertificateURL, String iosCertificatePassword) Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to the equivalent method that accepts a push token
static boolean	sendPushMessage(String token, String body, boolean production, String googleAuthKey, String iosCertificateURL, String iosCertificatePassword, int pushType, String... deviceKey) Deprecated. Please use new builder syntax with send() which includes parameters for new platforms such as UWP.
static boolean	sendPushMessage(String body, String deviceKey, boolean production, String googleAuthKey, String iosCertificateURL, String iosCertificatePassword, String bbUrl, String bbApp, String bbPass, String bbPort) Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to the equivalent method that accepts a push token
static boolean	sendPushMessage(String token, String body, String deviceKey, boolean production, String googleAuthKey, String iosCertificateURL, String iosCertificatePassword) Deprecated. Please use new builder syntax with send() which includes parameters for new platforms such as UWP.
static boolean	sendPushMessage(String token, String body, String deviceKey, boolean production, String googleAuthKey, String iosCertificateURL, String iosCertificatePassword, String bbUrl, String bbApp, String bbPass, String bbPort) Deprecated. Please use new builder syntax with send() which includes parameters for new platforms such as UWP.
static void	sendPushMessageAsync(String body, String deviceKey, boolean production, String googleAuthKey, String iosCertificateURL, String iosCertificatePassword) Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to the equivalent method that accepts a push token
static void	sendPushMessageAsync(String body, String deviceKey, boolean production, String googleAuthKey, String iosCertificateURL, String iosCertificatePassword, String bbUrl, String bbApp, String bbPass, String bbPort) Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to the equivalent method that accepts a push token
static void	sendPushMessageAsync(String token, String body, String deviceKey, boolean production, String googleAuthKey, String iosCertificateURL, String iosCertificatePassword) Deprecated. Please use new builder syntax with sendAsync() which includes parameters for new platforms such as UWP.
static void	sendPushMessageAsync(String token, String body, String deviceKey, boolean production, String googleAuthKey, String iosCertificateURL, String iosCertificatePassword, String bbUrl, String bbApp, String bbPass, String bbPort) Deprecated. Please use new builder syntax with sendAsync() which includes parameters for new platforms such as UWP.
Push	wnsAuth(String wnsSID, String wnsClientSecret) Sets authenticaton for WNS (Windows 10/UWP)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GOOGLE_PUSH_KEY

public static final String GOOGLE_PUSH_KEY

Key for the hashtable argument when pushing to the google play store

See Also:

Constant Field Values

Constructor Detail

Push

public Push(String token,
            String body,
            String... deviceKeys)

Creates a new push notification.

Parameters:

token - the authorization token from the account settings in the CodenameOne website, this is used to associate push quotas with your app

body - the body of the message

deviceKeys - Device keys when sending to specific devices.

Method Detail

gcmAuth

public Push gcmAuth(String googleAuthKey)

Sets authentication for GMS (Android and Chrome)

Parameters:

googleAuthKey - authorization key from the google play store

Returns:

self for chaining

apnsAuth

public Push apnsAuth(String iosCertificateURL,
                     String iosCertificatePassword,
                     boolean production)

Sets authentication for APNS (iOS)

Parameters:

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

production - True if this is a production certificate. False if this is a development certificate.

Returns:

Self for chaining

wnsAuth

public Push wnsAuth(String wnsSID,
                    String wnsClientSecret)

Sets authenticaton for WNS (Windows 10/UWP)

Parameters:

wnsSID - The SID from the Windows store.

wnsClientSecret - The client secret from the windows store

Returns:

self for chaining.

pushType

public Push pushType(int pushType)

Sets the type of push to use. See developer guide for details of different push types. Default is 1

Parameters:

pushType -

Returns:

Self for chaining.

send

public boolean send()

Sends push message.

Returns:

True if the request was successful.

sendAsync

public void sendAsync()

Sends push message asynchronously.

sendPushMessage

public static boolean sendPushMessage(String body,
                                      String deviceKey,
                                      boolean production,
                                      String googleAuthKey,
                                      String iosCertificateURL,
                                      String iosCertificatePassword)

Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to the equivalent method that accepts a push token

Sends a push message and returns true if server delivery succeeded, notice that the push message isn't guaranteed to reach all devices.

Parameters:

body - the body of the message

deviceKey - an optional parameter (can be null) when sending to a specific device

production - whether pushing to production or test/sandbox environment

googleAuthKey - authorization key from the google play store

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

Returns:

true if the message reached the Codename One server successfully, this makes no guarantee of delivery.

sendPushMessage

public static boolean sendPushMessage(String body,
                                      String deviceKey,
                                      boolean production,
                                      String googleAuthKey,
                                      String iosCertificateURL,
                                      String iosCertificatePassword,
                                      String bbUrl,
                                      String bbApp,
                                      String bbPass,
                                      String bbPort)

Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to the equivalent method that accepts a push token

Sends a push message and returns true if server delivery succeeded, notice that the push message isn't guaranteed to reach all devices.

Parameters:

body - the body of the message

deviceKey - an optional parameter (can be null) when sending to a specific device

production - whether pushing to production or test/sandbox environment

googleAuthKey - authorization key from the google play store

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

bbUrl - the URL to which the push should be submitted when sending a blackberry push for evaluation use https://pushapi.eval.blackberry.com for production you will need to apply at https://cp310.pushapi.na.blackberry.com

bbApp - the application id to authenticate on push for RIM devices

bbPass - the application password credentials authenticate on push for RIM devices

bbPort - the port of the blackberry push

Returns:

true if the message reached the Codename One server successfully, this makes no guarantee of delivery.

sendPushMessageAsync

public static void sendPushMessageAsync(String body,
                                        String deviceKey,
                                        boolean production,
                                        String googleAuthKey,
                                        String iosCertificateURL,
                                        String iosCertificatePassword)

Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to the equivalent method that accepts a push token

Sends a push message and returns true if server delivery succeeded, notice that the push message isn't guaranteed to reach all devices.

Parameters:

body - the body of the message

deviceKey - an optional parameter (can be null) when sending to a specific device

production - whether pushing to production or test/sandbox environment

googleAuthKey - authorization key from the google play store

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

sendPushMessageAsync

public static void sendPushMessageAsync(String body,
                                        String deviceKey,
                                        boolean production,
                                        String googleAuthKey,
                                        String iosCertificateURL,
                                        String iosCertificatePassword,
                                        String bbUrl,
                                        String bbApp,
                                        String bbPass,
                                        String bbPort)

Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to the equivalent method that accepts a push token

Sends a push message and returns true if server delivery succeeded, notice that the push message isn't guaranteed to reach all devices.

Parameters:

body - the body of the message

deviceKey - an optional parameter (can be null) when sending to a specific device

production - whether pushing to production or test/sandbox environment

googleAuthKey - authorization key from the google play store

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

bbUrl - the URL to which the push should be submitted when sending a blackberry push for evaluation use https://pushapi.eval.blackberry.com for production you will need to apply at https://cp310.pushapi.na.blackberry.com

bbApp - the application id to authenticate on push for RIM devices

bbPass - the application password credentials authenticate on push for RIM devices

bbPort - the port of the blackberry push

getDeviceKey

public static String getDeviceKey()

Deprecated. this method sends a push using the old push servers which will be retired, you need to switch to getPushKey()

Returns the push device key if the device was previously successfully registered for push otherwise returns null

Returns:

the device key that can be used to push to this specific device.

getPushKey

public static String getPushKey()

Returns the push device key if the device was previously successfully registered for push otherwise returns null

Returns:

the device key that can be used to push to this specific device.

sendPushMessage

public static boolean sendPushMessage(String token,
                                      String body,
                                      String deviceKey,
                                      boolean production,
                                      String googleAuthKey,
                                      String iosCertificateURL,
                                      String iosCertificatePassword)

Deprecated. Please use new builder syntax with send() which includes parameters for new platforms such as UWP.

Sends a push message and returns true if server delivery succeeded, notice that the push message isn't guaranteed to reach all devices. This method uses the new push servers

Parameters:

token - the authorization token from the account settings in the CodenameOne website, this is used to associate push quotas with your app

body - the body of the message

deviceKey - the device key that will receive the push message (can't be null!)

production - whether pushing to production or test/sandbox environment

googleAuthKey - authorization key from the google play store

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

Returns:

true if the message reached the Codename One server successfully, this makes no guarantee of delivery.

sendPushMessage

public static boolean sendPushMessage(String token,
                                      String body,
                                      boolean production,
                                      String googleAuthKey,
                                      String iosCertificateURL,
                                      String iosCertificatePassword,
                                      int pushType,
                                      String... deviceKey)

Deprecated. Please use new builder syntax with send() which includes parameters for new platforms such as UWP.

Sends a push message and returns true if server delivery succeeded, notice that the push message isn't guaranteed to reach all devices. This method uses the new push servers

Parameters:

token - the authorization token from the account settings in the CodenameOne website, this is used to associate push quotas with your app

body - the body of the message

production - whether pushing to production or test/sandbox environment

googleAuthKey - authorization key from the google play store

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

pushType - the type for the push in the server, this is useful for sending hidden pushes (type 2) should default to 0 or 1

deviceKey - set of devices that should receive the push

Returns:

true if the message reached the Codename One server successfully, this makes no guarantee of delivery.

sendPushMessage

public static boolean sendPushMessage(String token,
                                      String body,
                                      String deviceKey,
                                      boolean production,
                                      String googleAuthKey,
                                      String iosCertificateURL,
                                      String iosCertificatePassword,
                                      String bbUrl,
                                      String bbApp,
                                      String bbPass,
                                      String bbPort)

Deprecated. Please use new builder syntax with send() which includes parameters for new platforms such as UWP.

Sends a push message and returns true if server delivery succeeded, notice that the push message isn't guaranteed to reach all devices. This method uses the new push servers

Parameters:

token - the authorization token from the account settings in the CodenameOne website, this is used to associate push quotas with your app

body - the body of the message

deviceKey - an optional parameter (can be null) when sending to a specific device

production - whether pushing to production or test/sandbox environment

googleAuthKey - authorization key from the google play store

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

bbUrl - the URL to which the push should be submitted when sending a blackberry push for evaluation use https://pushapi.eval.blackberry.com for production you will need to apply at https://cp310.pushapi.na.blackberry.com

bbApp - the application id to authenticate on push for RIM devices

bbPass - the application password credentials authenticate on push for RIM devices

bbPort - the port of the blackberry push

Returns:

true if the message reached the Codename One server successfully, this makes no guarantee of delivery.

sendPushMessageAsync

public static void sendPushMessageAsync(String token,
                                        String body,
                                        String deviceKey,
                                        boolean production,
                                        String googleAuthKey,
                                        String iosCertificateURL,
                                        String iosCertificatePassword)

Deprecated. Please use new builder syntax with sendAsync() which includes parameters for new platforms such as UWP.

Sends a push message and returns true if server delivery succeeded, notice that the push message isn't guaranteed to reach all devices. This method uses the new push servers

Parameters:

token - the authorization token from the account settings in the CodenameOne website, this is used to associate push quotas with your app

body - the body of the message

deviceKey - an optional parameter (can be null) when sending to a specific device

production - whether pushing to production or test/sandbox environment

googleAuthKey - authorization key from the google play store

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

sendPushMessageAsync

public static void sendPushMessageAsync(String token,
                                        String body,
                                        String deviceKey,
                                        boolean production,
                                        String googleAuthKey,
                                        String iosCertificateURL,
                                        String iosCertificatePassword,
                                        String bbUrl,
                                        String bbApp,
                                        String bbPass,
                                        String bbPort)

Deprecated. Please use new builder syntax with sendAsync() which includes parameters for new platforms such as UWP.

Sends a push message and returns true if server delivery succeeded, notice that the push message isn't guaranteed to reach all devices. This method uses the new push servers

Parameters:

token - the authorization token from the account settings in the CodenameOne website, this is used to associate push quotas with your app

body - the body of the message

deviceKey - an optional parameter (can be null) when sending to a specific device

production - whether pushing to production or test/sandbox environment

googleAuthKey - authorization key from the google play store

iosCertificateURL - a URL where you host the iOS certificate for this applications push capabilities.

iosCertificatePassword - the password for the push certificate

bbUrl - the URL to which the push should be submitted when sending a blackberry push for evaluation use https://pushapi.eval.blackberry.com for production you will need to apply at https://cp310.pushapi.na.blackberry.com

bbApp - the application id to authenticate on push for RIM devices

bbPass - the application password credentials authenticate on push for RIM devices

bbPort - the port of the blackberry push