com.aylanetworks.aylasdk

Class AylaServiceApp

java.lang.Object

com.aylanetworks.aylasdk.AylaServiceApp

Direct Known Subclasses:

AylaDeviceNotificationApp, AylaPropertyTriggerApp

public class AylaServiceApp
extends java.lang.Object

Abstract class for Applications performed by the service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AylaServiceApp.NotificationType
static class	AylaServiceApp.PushType

Constructor Summary

Constructors

Constructor and Description
AylaServiceApp()

Method Summary

Modifier and Type	Method and Description
void	configureAsEmail(AylaContact contact, java.lang.String message, java.lang.String username, AylaEmailTemplate emailTemplate) Configures the receiver as AylaNotificationTypeEmail for the specified AylaContact with the specified message and AylaEmailTemplate
void	configureAsPushBaidu(java.lang.String applicationId, java.lang.String channelId, java.lang.String message, java.lang.String pushSound, java.lang.String pushMetaData) Configures the receiver as AylaNotificationType for Baidu
void	configureAsPushFCM(java.lang.String registrationId, java.lang.String message, java.lang.String pushSound, java.lang.String pushMetaData) Configures the receiver as AylaNotificationType for FCM Push defaulting to the application ID specified in the System Settings
void	configureAsPushFCM(java.lang.String applicationId, java.lang.String registrationId, java.lang.String message, java.lang.String pushSound, java.lang.String pushMetaData) Configures the receiver as AylaNotificationType for FCM Push
void	configureAsSMS(AylaContact contact, java.lang.String message) Configures the receiver as AylaNotificationTypeSMS for the specified AylaContact and message
void	configureAsSMS(java.lang.String countryCode, java.lang.String phoneNumber, java.lang.String username, java.lang.String message) Configures the receiver as AylaNotificationTypeSMS for the specified parameters.
java.lang.String	getChannelId()
java.lang.String	getContactId()
java.lang.String	getCountryCode()
java.lang.String	getEmailAddress()
AylaEmailTemplate	getEmailTemplate()
java.lang.String	getMessage()
java.lang.String	getNickname()
AylaServiceApp.NotificationType	getNotificationType()
java.lang.String	getPhoneNumber()
java.lang.String	getPushMdata()
java.lang.String	getPushSound()
java.lang.String	getRegistrationId()
java.lang.String	getRetrievedAt()
java.lang.String	getUsername()
void	populateFields()
void	setEmailAddress(java.lang.String emailAddress)
void	setEmailTemplate(AylaEmailTemplate emailTemplate)
void	setNickname(java.lang.String nickname)
void	setNotificationType(AylaServiceApp.NotificationType notificationType)
java.lang.String	toJSON()

Methods inherited from class java.lang.Object

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

Constructor Detail

AylaServiceApp

public AylaServiceApp()

Method Detail

getContactId

public java.lang.String getContactId()

getUsername

public java.lang.String getUsername()

getMessage

public java.lang.String getMessage()

getEmailAddress

public java.lang.String getEmailAddress()

getCountryCode

public java.lang.String getCountryCode()

getPhoneNumber

public java.lang.String getPhoneNumber()

getPushSound

public java.lang.String getPushSound()

getPushMdata

public java.lang.String getPushMdata()

getRetrievedAt

public java.lang.String getRetrievedAt()

getRegistrationId

public java.lang.String getRegistrationId()

getChannelId

public java.lang.String getChannelId()

getNickname

public java.lang.String getNickname()

getEmailTemplate

public AylaEmailTemplate getEmailTemplate()

getNotificationType

public AylaServiceApp.NotificationType getNotificationType()

setNickname

public void setNickname(java.lang.String nickname)

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)

setEmailTemplate

public void setEmailTemplate(AylaEmailTemplate emailTemplate)

setNotificationType

public void setNotificationType(AylaServiceApp.NotificationType notificationType)

toJSON

public java.lang.String toJSON()

populateFields

public void populateFields()

configureAsSMS

public void configureAsSMS(AylaContact contact,
                           java.lang.String message)

Configures the receiver as AylaNotificationTypeSMS for the specified AylaContact and message

Parameters:

contact - The AylaContact that will receive the app

message - The message of the SMS

configureAsSMS

public void configureAsSMS(java.lang.String countryCode,
                           java.lang.String phoneNumber,
                           java.lang.String username,
                           java.lang.String message)

Configures the receiver as AylaNotificationTypeSMS for the specified parameters. This is an alternative method instead of using AylaContact.

Parameters:

countryCode -

phoneNumber - The phone number

username - The username of the app

message - The message of the SMS

configureAsEmail

public void configureAsEmail(AylaContact contact,
                             java.lang.String message,
                             java.lang.String username,
                             AylaEmailTemplate emailTemplate)

Configures the receiver as AylaNotificationTypeEmail for the specified AylaContact with the specified message and AylaEmailTemplate

Parameters:

contact - The AylaContact that will receive the app

message - The message of the email

username - The username of the app

emailTemplate - An AylaEmailTemplate with the email specifications

configureAsPushFCM

public void configureAsPushFCM(java.lang.String registrationId,
                               java.lang.String message,
                               java.lang.String pushSound,
                               java.lang.String pushMetaData)

Configures the receiver as AylaNotificationType for FCM Push defaulting to the application ID specified in the System Settings

Parameters:

registrationId - The registration ID needed for FCM

message - The Push message for FCM

pushSound - The sound file name present on mobile app eg: my_sound_file.mp3

pushMetaData - Comma separated data needed by app eg: {"key1":"value1", "key2":"value2"}

configureAsPushFCM

public void configureAsPushFCM(java.lang.String applicationId,
                               java.lang.String registrationId,
                               java.lang.String message,
                               java.lang.String pushSound,
                               java.lang.String pushMetaData)

Configures the receiver as AylaNotificationType for FCM Push

Parameters:

applicationId - Application ID for this app, provided by Ayla Networks

registrationId - The registration ID needed for FCM

message - The Push message for FCM

pushSound - The sound file name present on mobile app eg: my_sound_file.mp3

pushMetaData - Comma separated data needed by app eg: {"key1":"value1", "key2":"value2"}

configureAsPushBaidu

public void configureAsPushBaidu(java.lang.String applicationId,
                                 java.lang.String channelId,
                                 java.lang.String message,
                                 java.lang.String pushSound,
                                 java.lang.String pushMetaData)

Configures the receiver as AylaNotificationType for Baidu

Parameters:

applicationId - The Application ID

channelId - The Channel ID

message - The Push Message

pushSound - The sound the Phone should emit on receiving this Notification

pushMetaData - The optional Meta Data to be included in the message