Skip navigation links

waggle.common.modules.device
Interface XDeviceModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XDeviceModule

public static interface XDeviceModule.Server

extends XAPIInterface.Server

Server interface for the Device Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XDeviceInfo	createDevice(XObjectID userID, String deviceName, XDeviceType deviceType, String deviceDeviceID, String deviceAppID, String deviceData, List<XNotificationGroup> deviceSettings) Create a new unique Device for the specified User.
void	deleteDevice(XObjectID deviceID) Remove an existing Device.
XDeviceInfo	findDevice(String deviceDeviceID, String deviceAppID) Find a Device by a device's unique IDs owned by the current User.
List<XDeviceInfo>	getConversationDevices(XObjectID conversationID) Get all Conversation Device override settings for the current user.
XDeviceInfo	getDevice(XObjectID deviceID) Get a Device by object ID.
List<XDeviceInfo>	getDevices(XObjectID userID) Get all Devices owned by the specified User.
XDeviceInfo	registerDevice(String deviceName, XDeviceType deviceType, String deviceDeviceID, String deviceAppID, String deviceData, List<XNotificationGroup> deviceSettings) Register or re-register a new or existing Device for the current User.
void	removeConversationDeviceSettings(XObjectID conversationID, XObjectID deviceID) Remove an existing Conversation Device override setting.
void	updateConversationDeviceSettings(XObjectID conversationID, XObjectID deviceID, List<XNotificationGroup> deviceSettings) Add or update an existing Conversation Device override setting.
XDeviceInfo	updateDevice(XObjectID deviceID, String deviceName, XDeviceType deviceType, String deviceDeviceID, String deviceAppID, String deviceData, List<XNotificationGroup> deviceSettings) Update an existing Device.
XDeviceInfo	updateDeviceSettings(XObjectID deviceID, List<XNotificationGroup> deviceSettings) Update an existing Device's settings.

Method Detail

registerDevice

XDeviceInfo registerDevice(String deviceName,
                           XDeviceType deviceType,
                           String deviceDeviceID,
                           String deviceAppID,
                           String deviceData,
                           List<XNotificationGroup> deviceSettings)

Register or re-register a new or existing Device for the current User.

Each Device must have a unique pair of DeviceID/AppID values.

This method will either create a new Device or update an existing device based on matching the DeviceID/AppID pair.

The name is not unique and can be changed at any time.

Parameters:

deviceName - The Device name.

deviceType - The Device's type.

deviceDeviceID - The Device's Device ID.

deviceAppID - The Device's App ID.

deviceData - The Device data.

deviceSettings - The Device notification settings. May be null.

Returns:

The Device Info.

createDevice

XDeviceInfo createDevice(XObjectID userID,
                         String deviceName,
                         XDeviceType deviceType,
                         String deviceDeviceID,
                         String deviceAppID,
                         String deviceData,
                         List<XNotificationGroup> deviceSettings)

Create a new unique Device for the specified User.

Each Device must have a unique pair of DeviceID/AppID values.

The Device must not already exist based upon matching the DeviceID/AppID pair.

The name is not unique and can be changed at any time.

The current user must either own the Device or be an admin.

Parameters:

userID - The User.

deviceName - The Device name.

deviceType - The Device's type.

deviceDeviceID - The Device's Device ID.

deviceAppID - The Device's App ID.

deviceData - The Device data.

deviceSettings - The Device notification settings. May be null.

Returns:

The Device Info.

updateDevice

XDeviceInfo updateDevice(XObjectID deviceID,
                         String deviceName,
                         XDeviceType deviceType,
                         String deviceDeviceID,
                         String deviceAppID,
                         String deviceData,
                         List<XNotificationGroup> deviceSettings)

Update an existing Device. Each Device must have a unique pair of deviceDeviceID and deviceAppID values.

The current user must either own the Device or be an admin.

Parameters:

deviceID - The Device.

deviceName - The Device name.

deviceType - The Device type.

deviceDeviceID - The Device's Device ID.

deviceAppID - The Device's App ID.

deviceData - The Device data.

deviceSettings - The Device notification settings. May be null.

Returns:

The Device Info.

updateDeviceSettings

XDeviceInfo updateDeviceSettings(XObjectID deviceID,
                                 List<XNotificationGroup> deviceSettings)

Update an existing Device's settings.

The current user must either own the Device or be an admin.

Parameters:

deviceID - The Device.

deviceSettings - The Device notification settings.

Returns:

The Device Info.

deleteDevice

void deleteDevice(XObjectID deviceID)

Remove an existing Device.

The current user must either own the Device or be an admin.

Parameters:

deviceID - The Device.

getDevices

List<XDeviceInfo> getDevices(XObjectID userID)

Get all Devices owned by the specified User.

The current user must either own the Device or be an admin.

Parameters:

userID - The User.

Returns:

All devices.

getDevice

XDeviceInfo getDevice(XObjectID deviceID)

Get a Device by object ID.

The current user must either own the Device or be an admin.

Parameters:

deviceID - The Device object ID.

Returns:

The Device.

findDevice

XDeviceInfo findDevice(String deviceDeviceID,
                       String deviceAppID)

Find a Device by a device's unique IDs owned by the current User. Each Device must have a unique pair of deviceDeviceID and deviceAppID values.

The current user must own the Device.

Parameters:

deviceDeviceID - The Device's Device ID.

deviceAppID - The Device's App ID.

Returns:

The Device or null if not found.

updateConversationDeviceSettings

void updateConversationDeviceSettings(XObjectID conversationID,
                                      XObjectID deviceID,
                                      List<XNotificationGroup> deviceSettings)

Add or update an existing Conversation Device override setting. These settings override the settings specified on the Device itself.

The current user must either own the Device or be an admin.

Parameters:

conversationID - The Conversation.

deviceID - The Device.

deviceSettings - The device notification override settings. These settings override the settings specified on the Device itself.

removeConversationDeviceSettings

void removeConversationDeviceSettings(XObjectID conversationID,
                                      XObjectID deviceID)

Remove an existing Conversation Device override setting. The settings on the Device itself will be used in the future.

The current user must either own the Device or be an admin.

Parameters:

conversationID - The Conversation.

deviceID - The Device.

getConversationDevices

List<XDeviceInfo> getConversationDevices(XObjectID conversationID)

Get all Conversation Device override settings for the current user.

Parameters:

conversationID - The Conversation.

Returns:

The Device Infos for this Conversation.

Skip navigation links