Package com.cumulocity.sdk.client.messaging.notifications

Interface NotificationSubscriptionApi

All Known Implementing Classes:

NotificationSubscriptionApiImpl

public interface NotificationSubscriptionApi

Manage notification subscriptions

Method Summary

Modifier and Type	Method	Description
void	delete(NotificationSubscriptionRepresentation subscription)	Delete by object.
void	deleteByFilter(NotificationSubscriptionFilter filter)	Deprecated. This method is deprecated and will throw an exception if the filter includes subscription, typeFilter or both.
void	deleteById(String subscriptionId)	Delete by ID.
void	deleteBySource(String source)	Deletes all subscriptions to a source in managed object context.
void	deleteTenantSubscriptions()	Deletes all subscriptions of the current tenant.
NotificationSubscriptionCollection	getSubscriptions()	Gets all the subscriptions.
NotificationSubscriptionCollection	getSubscriptionsByFilter(NotificationSubscriptionFilter filter)	Gets all the subscriptions matching a filter.
NotificationSubscriptionRepresentation	subscribe(NotificationSubscriptionRepresentation representation)	Creates a subscription to a source.

Method Details

subscribe

NotificationSubscriptionRepresentation subscribe(NotificationSubscriptionRepresentation representation)
                                          throws SDKException

Creates a subscription to a source.

Parameters:

representation - initial values for subscription

Returns:

subscription populated with an id

Throws:

SDKException

getSubscriptions

NotificationSubscriptionCollection getSubscriptions()
                                             throws SDKException

Gets all the subscriptions.

Returns:

all the subscriptions

Throws:

SDKException

getSubscriptionsByFilter

NotificationSubscriptionCollection getSubscriptionsByFilter(NotificationSubscriptionFilter filter)
                                                     throws SDKException

Gets all the subscriptions matching a filter. If the filter is null, return all subscriptions.

Parameters:

filter - values to be matched on

Returns:

subscriptions matching values

Throws:

SDKException

delete

void delete(NotificationSubscriptionRepresentation subscription)
     throws SDKException

Delete by object.

Parameters:

subscription - to delete

Throws:

SDKException

deleteById

void deleteById(String subscriptionId)
         throws SDKException

Delete by ID.

Parameters:

subscriptionId - of subscription to delete

Throws:

SDKException

deleteByFilter

@Deprecated
void deleteByFilter(NotificationSubscriptionFilter filter)
             throws SDKException

Deprecated.

This method is deprecated and will throw an exception if the filter includes subscription, typeFilter or both. Use delete(NotificationSubscriptionRepresentation), deleteById(String), or deleteBySource(String) instead.

Deletes all subscriptions matching a given filter.

Parameters:

filter - the filter criteria for deleting matching subscriptions

Throws:

SDKException - if the request fails or if disallowed filters are present

deleteBySource

void deleteBySource(String source)

Deletes all subscriptions to a source in managed object context.

Parameters:

source -

deleteTenantSubscriptions

void deleteTenantSubscriptions()

Deletes all subscriptions of the current tenant.