Package com.mypurecloud.sdk.v2.api

Class NotificationsApiAsync

java.lang.Object

com.mypurecloud.sdk.v2.api.NotificationsApiAsync

public class NotificationsApiAsync
extends Object

Constructor Summary

Constructors

Constructor	Description
NotificationsApiAsync()
NotificationsApiAsync(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Future<Void>	deleteNotificationsChannelSubscriptionsAsync(DeleteNotificationsChannelSubscriptionsRequest request, AsyncApiCallback<Void> callback)	Remove all subscriptions
Future<ApiResponse<Void>>	deleteNotificationsChannelSubscriptionsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Remove all subscriptions
Future<AvailableTopicEntityListing>	getNotificationsAvailabletopicsAsync(GetNotificationsAvailabletopicsRequest request, AsyncApiCallback<AvailableTopicEntityListing> callback)	Get available notification topics.
Future<ApiResponse<AvailableTopicEntityListing>>	getNotificationsAvailabletopicsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AvailableTopicEntityListing>> callback)	Get available notification topics.
Future<ChannelEntityListing>	getNotificationsChannelsAsync(GetNotificationsChannelsRequest request, AsyncApiCallback<ChannelEntityListing> callback)	The list of existing channels
Future<ApiResponse<ChannelEntityListing>>	getNotificationsChannelsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ChannelEntityListing>> callback)	The list of existing channels
Future<ChannelTopicEntityListing>	getNotificationsChannelSubscriptionsAsync(GetNotificationsChannelSubscriptionsRequest request, AsyncApiCallback<ChannelTopicEntityListing> callback)	The list of all subscriptions for this channel
Future<ApiResponse<ChannelTopicEntityListing>>	getNotificationsChannelSubscriptionsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ChannelTopicEntityListing>> callback)	The list of all subscriptions for this channel
Future<Void>	headNotificationsChannelAsync(HeadNotificationsChannelRequest request, AsyncApiCallback<Void> callback)	Verify a channel still exists and is valid Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't
Future<ApiResponse<Void>>	headNotificationsChannelAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Verify a channel still exists and is valid Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't
Future<Channel>	postNotificationsChannelsAsync(PostNotificationsChannelsRequest request, AsyncApiCallback<Channel> callback)	Create a new channel There is a limit of 20 channels per user/app combination.
Future<ApiResponse<Channel>>	postNotificationsChannelsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Channel>> callback)	Create a new channel There is a limit of 20 channels per user/app combination.
Future<ChannelTopicEntityListing>	postNotificationsChannelSubscriptionsAsync(PostNotificationsChannelSubscriptionsRequest request, AsyncApiCallback<ChannelTopicEntityListing> callback)	Add a list of subscriptions to the existing list of subscriptions
Future<ApiResponse<ChannelTopicEntityListing>>	postNotificationsChannelSubscriptionsAsync(ApiRequest<List<ChannelTopic>> request, AsyncApiCallback<ApiResponse<ChannelTopicEntityListing>> callback)	Add a list of subscriptions to the existing list of subscriptions
Future<ChannelTopicEntityListing>	putNotificationsChannelSubscriptionsAsync(PutNotificationsChannelSubscriptionsRequest request, AsyncApiCallback<ChannelTopicEntityListing> callback)	Replace the current list of subscriptions with a new list.
Future<ApiResponse<ChannelTopicEntityListing>>	putNotificationsChannelSubscriptionsAsync(ApiRequest<List<ChannelTopic>> request, AsyncApiCallback<ApiResponse<ChannelTopicEntityListing>> callback)	Replace the current list of subscriptions with a new list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NotificationsApiAsync

public NotificationsApiAsync()

NotificationsApiAsync

public NotificationsApiAsync(ApiClient apiClient)

Method Details

deleteNotificationsChannelSubscriptionsAsync

public Future<Void> deleteNotificationsChannelSubscriptionsAsync(DeleteNotificationsChannelSubscriptionsRequest request,
 AsyncApiCallback<Void> callback)

Remove all subscriptions

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteNotificationsChannelSubscriptionsAsync

public Future<ApiResponse<Void>> deleteNotificationsChannelSubscriptionsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<Void>> callback)

Remove all subscriptions

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getNotificationsAvailabletopicsAsync

public Future<AvailableTopicEntityListing> getNotificationsAvailabletopicsAsync(GetNotificationsAvailabletopicsRequest request,
 AsyncApiCallback<AvailableTopicEntityListing> callback)

Get available notification topics.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getNotificationsAvailabletopicsAsync

public Future<ApiResponse<AvailableTopicEntityListing>> getNotificationsAvailabletopicsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<AvailableTopicEntityListing>> callback)

Get available notification topics.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getNotificationsChannelSubscriptionsAsync

public Future<ChannelTopicEntityListing> getNotificationsChannelSubscriptionsAsync(GetNotificationsChannelSubscriptionsRequest request,
 AsyncApiCallback<ChannelTopicEntityListing> callback)

The list of all subscriptions for this channel

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getNotificationsChannelSubscriptionsAsync

public Future<ApiResponse<ChannelTopicEntityListing>> getNotificationsChannelSubscriptionsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<ChannelTopicEntityListing>> callback)

The list of all subscriptions for this channel

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getNotificationsChannelsAsync

public Future<ChannelEntityListing> getNotificationsChannelsAsync(GetNotificationsChannelsRequest request,
 AsyncApiCallback<ChannelEntityListing> callback)

The list of existing channels

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getNotificationsChannelsAsync

public Future<ApiResponse<ChannelEntityListing>> getNotificationsChannelsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<ChannelEntityListing>> callback)

The list of existing channels

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

headNotificationsChannelAsync

public Future<Void> headNotificationsChannelAsync(HeadNotificationsChannelRequest request,
 AsyncApiCallback<Void> callback)

Verify a channel still exists and is valid Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

headNotificationsChannelAsync

public Future<ApiResponse<Void>> headNotificationsChannelAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<Void>> callback)

Verify a channel still exists and is valid Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postNotificationsChannelSubscriptionsAsync

public Future<ChannelTopicEntityListing> postNotificationsChannelSubscriptionsAsync(PostNotificationsChannelSubscriptionsRequest request,
 AsyncApiCallback<ChannelTopicEntityListing> callback)

Add a list of subscriptions to the existing list of subscriptions

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postNotificationsChannelSubscriptionsAsync

public Future<ApiResponse<ChannelTopicEntityListing>> postNotificationsChannelSubscriptionsAsync(ApiRequest<List<ChannelTopic>> request,
 AsyncApiCallback<ApiResponse<ChannelTopicEntityListing>> callback)

Add a list of subscriptions to the existing list of subscriptions

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postNotificationsChannelsAsync

public Future<Channel> postNotificationsChannelsAsync(PostNotificationsChannelsRequest request,
 AsyncApiCallback<Channel> callback)

Create a new channel There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postNotificationsChannelsAsync

public Future<ApiResponse<Channel>> postNotificationsChannelsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<Channel>> callback)

Create a new channel There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putNotificationsChannelSubscriptionsAsync

public Future<ChannelTopicEntityListing> putNotificationsChannelSubscriptionsAsync(PutNotificationsChannelSubscriptionsRequest request,
 AsyncApiCallback<ChannelTopicEntityListing> callback)

Replace the current list of subscriptions with a new list.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putNotificationsChannelSubscriptionsAsync

public Future<ApiResponse<ChannelTopicEntityListing>> putNotificationsChannelSubscriptionsAsync(ApiRequest<List<ChannelTopic>> request,
 AsyncApiCallback<ApiResponse<ChannelTopicEntityListing>> callback)

Replace the current list of subscriptions with a new list.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed