PushService (Kuali Mobility Enterprise 2.3.0 API)

All Known Implementing Classes:

PushServiceImpl
```
public interface PushService
```
Interface for sending and persisting Push messages to Device. Implementations of this service will typically persist Push messages from a database, retrieve devices from a service, and send the message to the devices using an implementatin of the SendService interface.

Since:

2.0.0

Author:

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

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`countPushes()` Returns the number of `Push` messages persisted.
`List<Push>`	`findAllPush()` Returns a list of ALL the `Push` messages that are persisted. WARNING: This method can return A LOT of data
`List<Device>`	`findDevicesForPush(Push push)` Finds a list of `Devices` that was linked to a `Push`.
`Push`	`findPushById(Long id)` Finds a `Push` by its ID.
`List<PushDeviceTuple>`	`findUnsentPushTuples()` Finds a list of unsent `PushDeviceTuple`.
`boolean`	`removePush(Push push)` Removes a `Push` message.
`void`	`savePush(Push push)` Persists a `Push` message.
`void`	`savePush(Push push, List<Device> Devices)` Persists a push messages that should be sent to many devices
`int`	`sendPush(List<PushDeviceTuple> tuples)` Attempts to send `PushDeviceTuple`
`int`	`sendPush(Push push, Device device)` Sends a `Push` message to the specified `Device` without persisting the message.
`int`	`sendPush(Push push, List<Device> devices)` Sends a `Push`

- Method Detail
  - savePush
```
void savePush(Push push)
```
    Persists a Push message.
    
    Parameters:
    push - Push message to persist.
  - removePush
```
boolean removePush(Push push)
```
    Removes a Push message.
    
    Parameters:
    push - Push message to persist.
  - savePush
```
void savePush(Push push,
            List<Device> Devices)
```
    Persists a push messages that should be sent to many devices
    
    Parameters:
    push - Push message to be sent.
    Devices - Devices the Push message should be sent to.
  - countPushes
```
int countPushes()
```
    Returns the number of Push messages persisted.
    
    Returns:
    number of Push messages persisted.
  - findPushById
```
Push findPushById(Long id)
```
    Finds a Push by its ID.
    
    Parameters:
    id - ID of the Push to find.
    
    Returns:
    The Push that has the specified ID.
  - findAllPush
```
List<Push> findAllPush()
```
    Returns a list of ALL the Push messages that are persisted.
    WARNING: This method can return A LOT of data
    
    Returns:
    A lsit of all the persisted Push messages.
  - findDevicesForPush
```
List<Device> findDevicesForPush(Push push)
```
    Finds a list of Devices that was linked to a Push.
    
    Parameters:
    push - Push to find devices of.
    
    Returns:
    List of Devices that was linked.
  - findUnsentPushTuples
```
List<PushDeviceTuple> findUnsentPushTuples()
```
    Finds a list of unsent PushDeviceTuple.
    
    Returns:
    List of unsent PushDeviceTuple.
  - sendPush
```
int sendPush(Push push,
           Device device)
```
    Sends a Push message to the specified Device without persisting the message.
    
    Parameters:
    push - Push message to send.
    device - Device to send the message to.
  - sendPush
```
int sendPush(Push push,
           List<Device> devices)
```
    Sends a Push Parameters: push - Push message to send. devices - Devices to send the message to.
  sendPush int sendPush(List<PushDeviceTuple> tuples) Attempts to send PushDeviceTuple Parameters: tuples - List of PushDeviceTuple to send. Returns:

Interface PushService

Method Summary

Method Detail

savePush

removePush

savePush

countPushes

findPushById

findAllPush

findDevicesForPush

findUnsentPushTuples

sendPush

sendPush

sendPush