org.kuali.mobility.push.service

Interface SendService

All Known Implementing Classes:

AndroidSendService, BlackberrySendService, iOSSendService, SendServiceDelegator

public interface SendService

This is an interface for an service that can send Push messages to devices. The implementation of this service should understand how to send a message to each.

Since:

2.1.0

Author:

Kuali Mobility Team (mobility.dev@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
void	sendPush(Push push, Device device) Sends a Push message to one specific device.
void	sendPush(Push push, List<Device> devices) Sends a Push message to a list of devices.

Method Detail

sendPush

void sendPush(Push push,
            Device device)
              throws IllegalArgumentException

Sends a Push message to one specific device. If the implementation can not send a message to the specified device eg. The implementation can only send to Android devices and a iOS device is specified, an InvalidArgumentException can be thrown.

Parameters:

push - The Push message to send.

devices - The device to send the message to.

Throws:

IllegalArgumentException

sendPush

void sendPush(Push push,
            List<Device> devices)
              throws IllegalArgumentException

Sends a Push message to a list of devices. If the implementation can not send a message to one (or more) of the devices in the list, the service may throw an IllegalArgumentException and not send further to any other devices in the list.

Parameters:

push - The Push message to send.

devices - The list of devices to send the message to.

Throws:

IllegalArgumentException