com.microsoft.windowsazure.messaging

Class NotificationHub

java.lang.Object

com.microsoft.windowsazure.messaging.NotificationHub

public class NotificationHub
extends java.lang.Object

The notification hub client

Constructor Summary

Constructors

Constructor and Description
NotificationHub(java.lang.String notificationHubPath, java.lang.String connectionString, android.content.Context context) Creates a new NotificationHub client

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getConnectionString() Gets the Notification Hub connection string
java.lang.String	getNotificationHubPath() Gets the Notification Hub path
Registration	register(java.lang.String pnsHandle, java.lang.String... tags) Registers the client for native notifications with the specified tags
Registration	registerBaidu(java.lang.String userId, java.lang.String channelId, java.lang.String... tags) Registers the client for native notifications with the specified tags
TemplateRegistration	registerBaiduTemplate(java.lang.String userId, java.lang.String channelId, java.lang.String templateName, java.lang.String template, java.lang.String... tags) Registers the client for template notifications with the specified tags
TemplateRegistration	registerTemplate(java.lang.String pnsHandle, java.lang.String templateName, java.lang.String template, java.lang.String... tags) Registers the client for template notifications with the specified tags
void	setConnectionString(java.lang.String connectionString) Sets the Notification Hub connection string
void	setNotificationHubPath(java.lang.String notificationHubPath) Sets the Notification Hub path
void	unregister() Unregisters the client for native notifications
void	unregisterAll(java.lang.String pnsHandle) Unregisters the client for all notifications
void	unregisterTemplate(java.lang.String templateName) Unregisters the client for template notifications of a specific template

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationHub

public NotificationHub(java.lang.String notificationHubPath,
               java.lang.String connectionString,
               android.content.Context context)

Creates a new NotificationHub client

Parameters:

notificationHubPath - Notification Hub path

connectionString - Notification Hub connection string

context - Android context used to access SharedPreferences

Method Detail

register

public Registration register(java.lang.String pnsHandle,
                    java.lang.String... tags)
                      throws java.lang.Exception

Registers the client for native notifications with the specified tags

Parameters:

pnsHandle - PNS specific identifier

tags - Tags to use in the registration

Returns:

The created registration

Throws:

java.lang.Exception

registerBaidu

public Registration registerBaidu(java.lang.String userId,
                         java.lang.String channelId,
                         java.lang.String... tags)
                           throws java.lang.Exception

Registers the client for native notifications with the specified tags

Parameters:

userId - Baidu user Id

channelId - Baidu channel Id

tags - Tags to use in the registration

Returns:

The created registration

Throws:

java.lang.Exception

registerTemplate

public TemplateRegistration registerTemplate(java.lang.String pnsHandle,
                                    java.lang.String templateName,
                                    java.lang.String template,
                                    java.lang.String... tags)
                                      throws java.lang.Exception

Registers the client for template notifications with the specified tags

Parameters:

pnsHandle - PNS specific identifier

templateName - The template name

template - The template body

tags - The tags to use in the registration

Returns:

The created registration

Throws:

java.lang.Exception

registerBaiduTemplate

public TemplateRegistration registerBaiduTemplate(java.lang.String userId,
                                         java.lang.String channelId,
                                         java.lang.String templateName,
                                         java.lang.String template,
                                         java.lang.String... tags)
                                           throws java.lang.Exception

Registers the client for template notifications with the specified tags

Parameters:

userId - The User Id

channelId - The channel Id

templateName - The template name

template - The template body

tags - The tags to use in the registration

Returns:

The created registration

Throws:

java.lang.Exception

unregister

public void unregister()
                throws java.lang.Exception

Unregisters the client for native notifications

Throws:

java.lang.Exception

unregisterTemplate

public void unregisterTemplate(java.lang.String templateName)
                        throws java.lang.Exception

Unregisters the client for template notifications of a specific template

Parameters:

templateName - The template name

Throws:

java.lang.Exception

unregisterAll

public void unregisterAll(java.lang.String pnsHandle)
                   throws java.lang.Exception

Unregisters the client for all notifications

Parameters:

pnsHandle - PNS specific identifier

Throws:

java.lang.Exception

getConnectionString

public java.lang.String getConnectionString()

Gets the Notification Hub connection string

setConnectionString

public void setConnectionString(java.lang.String connectionString)

Sets the Notification Hub connection string

getNotificationHubPath

public java.lang.String getNotificationHubPath()

Gets the Notification Hub path

setNotificationHubPath

public void setNotificationHubPath(java.lang.String notificationHubPath)

Sets the Notification Hub path