Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.windowsazure.messaging.INotificationHub Maven / Gradle / Ivy
package com.windowsazure.messaging;
import java.util.Date;
import java.util.List;
import java.util.Set;
import org.apache.http.concurrent.FutureCallback;
/**
* Interface for the REST wrapper of WIndows Azure Notification Hubs
*/
public interface INotificationHub {
void createOrUpdateInstallation(Installation installation) throws NotificationHubsException;
void patchInstallation(String installationId, PartialUpdateOperation... operations) throws NotificationHubsException;
void patchInstallation(String installationId, List operations) throws NotificationHubsException;
void deleteInstallation(String installationId) throws NotificationHubsException;
Installation getInstallation(String installationId) throws NotificationHubsException;
NotificationOutcome scheduleNotification(Notification notification, Date scheduledTime) throws NotificationHubsException;
NotificationOutcome scheduleNotification(Notification notification, Set tags, Date scheduledTime) throws NotificationHubsException;
NotificationOutcome scheduleNotification(Notification notification, String tagExpression, Date scheduledTime) throws NotificationHubsException;
NotificationOutcome sendDirectNotification(Notification notification, String deviceHandle) throws NotificationHubsException;
NotificationOutcome sendDirectNotification(Notification notification, List deviceHandles) throws NotificationHubsException;
void cancelScheduledNotification(String notificationId) throws NotificationHubsException;
NotificationHubJob submitNotificationHubJob(NotificationHubJob job) throws NotificationHubsException;
NotificationHubJob getNotificationHubJob(String jobId) throws NotificationHubsException;
List getAllNotificationHubJobs() throws NotificationHubsException;
NotificationTelemetry getNotificationTelemetry(String notificationId) throws NotificationHubsException;
void createRegistrationIdAsync(FutureCallback callback);
void createRegistrationAsync(Registration registration, FutureCallback callback);
void updateRegistrationAsync(Registration registration, FutureCallback callback);
void upsertRegistrationAsync(Registration registration, FutureCallback callback);
void deleteRegistrationAsync(Registration registration, FutureCallback callback);
void deleteRegistrationAsync(String registrationId, FutureCallback callback);
void getRegistrationAsync(String registrationId, FutureCallback callback);
void getRegistrationsByChannelAsync(String channel, int top, String continuationToken, FutureCallback callback);
void getRegistrationsByTagAsync(String tag, int top, String continuationToken, FutureCallback callback);
void getRegistrationsByTagAsync(String tag, FutureCallback callback);
void getRegistrationsByChannelAsync(String channel, FutureCallback callback);
void getRegistrationsAsync(int top, String continuationToken, FutureCallback callback);
void sendNotificationAsync(Notification notification, FutureCallback callback);
void sendNotificationAsync(Notification notification, Set tags, FutureCallback callback);
void sendNotificationAsync(Notification notification, String tagExpression, FutureCallback callback);
void sendDirectNotificationAsync(Notification notification, String deviceHandle, FutureCallback callback);
void sendDirectNotificationAsync(Notification notification, List deviceHandles, FutureCallback callback);
void scheduleNotificationAsync(Notification notification, Date scheduledTime, FutureCallback callback);
void scheduleNotificationAsync(Notification notification, Set tags, Date scheduledTime, FutureCallback callback);
void scheduleNotificationAsync(Notification notification, String tagExpression, Date scheduledTime, FutureCallback callback);
void cancelScheduledNotificationAsync(String notificationId, FutureCallback callback);
void createOrUpdateInstallationAsync(Installation installation, FutureCallback callback);
void patchInstallationAsync(String installationId, List operations, FutureCallback callback);
void patchInstallationAsync(String installationId, FutureCallback callback, PartialUpdateOperation... operations);
void deleteInstallationAsync(String installationId, FutureCallback callback);
void getInstallationAsync(String installationId, FutureCallback callback);
void submitNotificationHubJobAsync(NotificationHubJob job, FutureCallback callback);
void getNotificationHubJobAsync(String jobId, FutureCallback callback);
void getAllNotificationHubJobsAsync(FutureCallback> callback);
void getNotificationTelemetryAsync(String notificationId, FutureCallback callback);
/**
* Create a registrationId, without creating an actual registration. To create use upsert.
* This method is used when the registration id is stored only on the device.
*
* @return a registration id.
*/
String createRegistrationId() throws NotificationHubsException;
/**
* This method creates a new registration
* @param registration A registration object containing the description of the registration to create.
* ETag and registrationid are ignored
*
* @return the created registration containing the read-only parameters (registrationid, etag, and expiration time).
*/
Registration createRegistration(Registration registration) throws NotificationHubsException;
/**
* This methods updates an existing registration
*
* @param registration A registration object containing the description of the registration to update.
* The registration id has to be populated.
*
* @throws NotificationHubsException
* runtime exception if the registration already exists
*
* @return the updated registration containing the read-only parameters (registrationid, etag, and expiration time).
*/
Registration updateRegistration(Registration registration) throws NotificationHubsException;
/**
* This method updates or creates a new regiostration with the registration id specified.
*
* @param registration A registration object containing the description of the registration to create or update.
* The registration id has to be populated.
*
* @return the updated registration containing the read-only parameters (registrationid, etag, and expiration time).
*/
Registration upsertRegistration(Registration registration) throws NotificationHubsException;
/**
* Deletes a registration.
*
* @param registration. Registration id has to be populated.
*/
void deleteRegistration(Registration registration) throws NotificationHubsException;
/**
* Deletes a registration.
*
* @param registrationId
*/
void deleteRegistration(String registrationId) throws NotificationHubsException;
/**
* Retrieves the description of a registration based on the id.
*
* @param registrationId
* @return A registration object
*/
Registration getRegistration(String registrationId) throws NotificationHubsException;
/**
* Return all registrations in this hub
*
* @return Registration collection.
*/
CollectionResult getRegistrations() throws NotificationHubsException;
/**
* Returns all registrations in this hub
*
* @param top The maximum number of registrations to return (max 100)
* @param continuationToken If not-null, continues iterating through a previously requested query.
*
* @return Registration collection.
*/
CollectionResult getRegistrations(int top, String continuationToken) throws NotificationHubsException;
/**
* Returns all registrations with a specific tag
*
* @param tag
*
* @return Registration Collection
*/
CollectionResult getRegistrationsByTag(String tag) throws NotificationHubsException;
/**
* Returns all registrations with a specific tag
*
* @param tag
* @param top The maximum number of registrations to return (max 100)
* @param continuationToken If not-null, continues iterating through a previously requested query.
*
* @return Registration Collection
*/
CollectionResult getRegistrationsByTag(String tag, int top, String continuationToken) throws NotificationHubsException;
/**
* Returns all registration with a specific channel (e.g. ChannelURI, device token)
* @param channel
* @return Registration Collection
*/
CollectionResult getRegistrationsByChannel(String channel) throws NotificationHubsException;
/**
* Returns all registration with a specific channel (e.g. ChannelURI, device token)
* @param channel
* @param top The maximum number of registrations to return (max 100)
* @param continuationToken If not-null, continues iterating through a previously requested query.
* @return Registration Collection
*/
CollectionResult getRegistrationsByChannel(String channel, int top, String continuationToken) throws NotificationHubsException;
/**
* Sends a notification to all eligible registrations (i.e. only correct platform, if notification is platform specific)
*
* @param notification
*/
NotificationOutcome sendNotification(Notification notification) throws NotificationHubsException;
/**
* Sends a notifications to all eligible registrations with at least one of the specified tags
*
* @param notification
* @param tags
*/
NotificationOutcome sendNotification(Notification notification, Set tags) throws NotificationHubsException;
/**
* Sends a notifications to all eligible registrations that satisfy the provided tag expression
*
* @param notification
* @param tagExpression
*/
NotificationOutcome sendNotification(Notification notification, String tagExpression) throws NotificationHubsException;
}
