Package com.mypurecloud.sdk.v2.api

Class PresenceApiAsync

java.lang.Object

com.mypurecloud.sdk.v2.api.PresenceApiAsync

public class PresenceApiAsync
extends Object

Constructor Summary

Constructors

Constructor	Description
PresenceApiAsync()
PresenceApiAsync(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Future<Void>	deletePresenceDefinition0Async(DeletePresenceDefinition0Request request, AsyncApiCallback<Void> callback)	Delete a Presence Definition
Future<ApiResponse<Void>>	deletePresenceDefinition0Async(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete a Presence Definition
Future<Void>	deletePresencedefinitionAsync(DeletePresencedefinitionRequest request, AsyncApiCallback<Void> callback)	Deprecated.
Future<ApiResponse<Void>>	deletePresencedefinitionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Deprecated.
Future<Void>	deletePresenceSourceAsync(DeletePresenceSourceRequest request, AsyncApiCallback<Void> callback)	Delete a Presence Source
Future<ApiResponse<Void>>	deletePresenceSourceAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete a Presence Source
Future<OrganizationPresenceDefinition>	getPresenceDefinition0Async(GetPresenceDefinition0Request request, AsyncApiCallback<OrganizationPresenceDefinition> callback)	Get a Presence Definition
Future<ApiResponse<OrganizationPresenceDefinition>>	getPresenceDefinition0Async(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationPresenceDefinition>> callback)	Get a Presence Definition
Future<OrganizationPresence>	getPresencedefinitionAsync(GetPresencedefinitionRequest request, AsyncApiCallback<OrganizationPresence> callback)	Deprecated.
Future<ApiResponse<OrganizationPresence>>	getPresencedefinitionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationPresence>> callback)	Deprecated.
Future<OrganizationPresenceDefinitionEntityListing>	getPresenceDefinitions0Async(GetPresenceDefinitions0Request request, AsyncApiCallback<OrganizationPresenceDefinitionEntityListing> callback)	Get a list of Presence Definitions
Future<ApiResponse<OrganizationPresenceDefinitionEntityListing>>	getPresenceDefinitions0Async(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationPresenceDefinitionEntityListing>> callback)	Get a list of Presence Definitions
Future<OrganizationPresenceEntityListing>	getPresencedefinitionsAsync(GetPresencedefinitionsRequest request, AsyncApiCallback<OrganizationPresenceEntityListing> callback)	Deprecated.
Future<ApiResponse<OrganizationPresenceEntityListing>>	getPresencedefinitionsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationPresenceEntityListing>> callback)	Deprecated.
Future<PresenceSettings>	getPresenceSettingsAsync(GetPresenceSettingsRequest request, AsyncApiCallback<PresenceSettings> callback)	Get the presence settings
Future<ApiResponse<PresenceSettings>>	getPresenceSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<PresenceSettings>> callback)	Get the presence settings
Future<Source>	getPresenceSourceAsync(GetPresenceSourceRequest request, AsyncApiCallback<Source> callback)	Get a Presence Source
Future<ApiResponse<Source>>	getPresenceSourceAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Source>> callback)	Get a Presence Source
Future<SourceEntityListing>	getPresenceSourcesAsync(GetPresenceSourcesRequest request, AsyncApiCallback<SourceEntityListing> callback)	Get a list of Presence Sources
Future<ApiResponse<SourceEntityListing>>	getPresenceSourcesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<SourceEntityListing>> callback)	Get a list of Presence Sources
Future<UserPrimarySource>	getPresenceUserPrimarysourceAsync(GetPresenceUserPrimarysourceRequest request, AsyncApiCallback<UserPrimarySource> callback)	Get a user's Primary Presence Source
Future<ApiResponse<UserPrimarySource>>	getPresenceUserPrimarysourceAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserPrimarySource>> callback)	Get a user's Primary Presence Source
Future<List<SystemPresence>>	getSystempresencesAsync(GetSystempresencesRequest request, AsyncApiCallback<List<SystemPresence>> callback)	Get the list of SystemPresences
Future<ApiResponse<List<SystemPresence>>>	getSystempresencesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<SystemPresence>>> callback)	Get the list of SystemPresences
Future<UserPresence>	getUserPresenceAsync(GetUserPresenceRequest request, AsyncApiCallback<UserPresence> callback)	Get a user's Presence Get a user's presence for the specified source that is not specifically listed.
Future<ApiResponse<UserPresence>>	getUserPresenceAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserPresence>> callback)	Get a user's Presence Get a user's presence for the specified source that is not specifically listed.
Future<UserPresence>	getUserPresencesPurecloudAsync(GetUserPresencesPurecloudRequest request, AsyncApiCallback<UserPresence> callback)	Get a user's Genesys Cloud presence.
Future<ApiResponse<UserPresence>>	getUserPresencesPurecloudAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserPresence>> callback)	Get a user's Genesys Cloud presence.
Future<List<UcUserPresence>>	getUsersPresenceBulkAsync(GetUsersPresenceBulkRequest request, AsyncApiCallback<List<UcUserPresence>> callback)	Get bulk user presences for a single presence source
Future<ApiResponse<List<UcUserPresence>>>	getUsersPresenceBulkAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<UcUserPresence>>> callback)	Get bulk user presences for a single presence source
Future<List<UcUserPresence>>	getUsersPresencesPurecloudBulkAsync(GetUsersPresencesPurecloudBulkRequest request, AsyncApiCallback<List<UcUserPresence>> callback)	Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
Future<ApiResponse<List<UcUserPresence>>>	getUsersPresencesPurecloudBulkAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<UcUserPresence>>> callback)	Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
Future<UserPresence>	patchUserPresenceAsync(PatchUserPresenceRequest request, AsyncApiCallback<UserPresence> callback)	Patch a user's Presence Patch a user's presence for the specified source that is not specifically listed.
Future<ApiResponse<UserPresence>>	patchUserPresenceAsync(ApiRequest<UserPresence> request, AsyncApiCallback<ApiResponse<UserPresence>> callback)	Patch a user's Presence Patch a user's presence for the specified source that is not specifically listed.
Future<UserPresence>	patchUserPresencesPurecloudAsync(PatchUserPresencesPurecloudRequest request, AsyncApiCallback<UserPresence> callback)	Patch a Genesys Cloud user's presence The presence object can be patched one of three ways.
Future<ApiResponse<UserPresence>>	patchUserPresencesPurecloudAsync(ApiRequest<UserPresence> request, AsyncApiCallback<ApiResponse<UserPresence>> callback)	Patch a Genesys Cloud user's presence The presence object can be patched one of three ways.
Future<OrganizationPresenceDefinition>	postPresenceDefinitions0Async(PostPresenceDefinitions0Request request, AsyncApiCallback<OrganizationPresenceDefinition> callback)	Create a Presence Definition
Future<ApiResponse<OrganizationPresenceDefinition>>	postPresenceDefinitions0Async(ApiRequest<OrganizationPresenceDefinition> request, AsyncApiCallback<ApiResponse<OrganizationPresenceDefinition>> callback)	Create a Presence Definition
Future<OrganizationPresence>	postPresencedefinitionsAsync(PostPresencedefinitionsRequest request, AsyncApiCallback<OrganizationPresence> callback)	Deprecated.
Future<ApiResponse<OrganizationPresence>>	postPresencedefinitionsAsync(ApiRequest<OrganizationPresence> request, AsyncApiCallback<ApiResponse<OrganizationPresence>> callback)	Deprecated.
Future<Source>	postPresenceSourcesAsync(PostPresenceSourcesRequest request, AsyncApiCallback<Source> callback)	Create a Presence Source
Future<ApiResponse<Source>>	postPresenceSourcesAsync(ApiRequest<Source> request, AsyncApiCallback<ApiResponse<Source>> callback)	Create a Presence Source
Future<OrganizationPresenceDefinition>	putPresenceDefinition0Async(PutPresenceDefinition0Request request, AsyncApiCallback<OrganizationPresenceDefinition> callback)	Update a Presence Definition
Future<ApiResponse<OrganizationPresenceDefinition>>	putPresenceDefinition0Async(ApiRequest<OrganizationPresenceDefinition> request, AsyncApiCallback<ApiResponse<OrganizationPresenceDefinition>> callback)	Update a Presence Definition
Future<OrganizationPresence>	putPresencedefinitionAsync(PutPresencedefinitionRequest request, AsyncApiCallback<OrganizationPresence> callback)	Deprecated.
Future<ApiResponse<OrganizationPresence>>	putPresencedefinitionAsync(ApiRequest<OrganizationPresence> request, AsyncApiCallback<ApiResponse<OrganizationPresence>> callback)	Deprecated.
Future<PresenceSettings>	putPresenceSettingsAsync(PutPresenceSettingsRequest request, AsyncApiCallback<PresenceSettings> callback)	Update the presence settings
Future<ApiResponse<PresenceSettings>>	putPresenceSettingsAsync(ApiRequest<PresenceSettings> request, AsyncApiCallback<ApiResponse<PresenceSettings>> callback)	Update the presence settings
Future<Source>	putPresenceSourceAsync(PutPresenceSourceRequest request, AsyncApiCallback<Source> callback)	Update a Presence Source
Future<ApiResponse<Source>>	putPresenceSourceAsync(ApiRequest<Source> request, AsyncApiCallback<ApiResponse<Source>> callback)	Update a Presence Source
Future<UserPrimarySource>	putPresenceUserPrimarysourceAsync(PutPresenceUserPrimarysourceRequest request, AsyncApiCallback<UserPrimarySource> callback)	Update a user's Primary Presence Source
Future<ApiResponse<UserPrimarySource>>	putPresenceUserPrimarysourceAsync(ApiRequest<UserPrimarySource> request, AsyncApiCallback<ApiResponse<UserPrimarySource>> callback)	Update a user's Primary Presence Source
Future<List<UserPresence>>	putUsersPresencesBulkAsync(PutUsersPresencesBulkRequest request, AsyncApiCallback<List<UserPresence>> callback)	Update bulk user Presences
Future<ApiResponse<List<UserPresence>>>	putUsersPresencesBulkAsync(ApiRequest<List<MutableUserPresence>> request, AsyncApiCallback<ApiResponse<List<UserPresence>>> callback)	Update bulk user Presences

Methods inherited from class java.lang.Object

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

Constructor Details

PresenceApiAsync

public PresenceApiAsync()

PresenceApiAsync

public PresenceApiAsync(ApiClient apiClient)

Method Details

deletePresenceDefinition0Async

public Future<Void> deletePresenceDefinition0Async(DeletePresenceDefinition0Request request,
 AsyncApiCallback<Void> callback)

Delete a Presence Definition

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deletePresenceDefinition0Async

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

Delete a Presence Definition

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deletePresenceSourceAsync

public Future<Void> deletePresenceSourceAsync(DeletePresenceSourceRequest request,
 AsyncApiCallback<Void> callback)

Delete a Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deletePresenceSourceAsync

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

Delete a Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deletePresencedefinitionAsync

public Future<Void> deletePresencedefinitionAsync(DeletePresencedefinitionRequest request,
 AsyncApiCallback<Void> callback)

Deprecated.

Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deletePresencedefinitionAsync

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

Deprecated.

Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceDefinition0Async

public Future<OrganizationPresenceDefinition> getPresenceDefinition0Async(GetPresenceDefinition0Request request,
 AsyncApiCallback<OrganizationPresenceDefinition> callback)

Get a Presence Definition

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceDefinition0Async

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

Get a Presence Definition

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceDefinitions0Async

public Future<OrganizationPresenceDefinitionEntityListing> getPresenceDefinitions0Async(GetPresenceDefinitions0Request request,
 AsyncApiCallback<OrganizationPresenceDefinitionEntityListing> callback)

Get a list of Presence Definitions

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceDefinitions0Async

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

Get a list of Presence Definitions

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceSettingsAsync

public Future<PresenceSettings> getPresenceSettingsAsync(GetPresenceSettingsRequest request,
 AsyncApiCallback<PresenceSettings> callback)

Get the presence settings

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceSettingsAsync

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

Get the presence settings

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceSourceAsync

public Future<Source> getPresenceSourceAsync(GetPresenceSourceRequest request,
 AsyncApiCallback<Source> callback)

Get a Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceSourceAsync

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

Get a Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceSourcesAsync

public Future<SourceEntityListing> getPresenceSourcesAsync(GetPresenceSourcesRequest request,
 AsyncApiCallback<SourceEntityListing> callback)

Get a list of Presence Sources

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceSourcesAsync

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

Get a list of Presence Sources

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceUserPrimarysourceAsync

public Future<UserPrimarySource> getPresenceUserPrimarysourceAsync(GetPresenceUserPrimarysourceRequest request,
 AsyncApiCallback<UserPrimarySource> callback)

Get a user's Primary Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresenceUserPrimarysourceAsync

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

Get a user's Primary Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresencedefinitionAsync

public Future<OrganizationPresence> getPresencedefinitionAsync(GetPresencedefinitionRequest request,
 AsyncApiCallback<OrganizationPresence> callback)

Deprecated.

Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresencedefinitionAsync

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

Deprecated.

Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresencedefinitionsAsync

public Future<OrganizationPresenceEntityListing> getPresencedefinitionsAsync(GetPresencedefinitionsRequest request,
 AsyncApiCallback<OrganizationPresenceEntityListing> callback)

Deprecated.

Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getPresencedefinitionsAsync

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

Deprecated.

Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getSystempresencesAsync

public Future<List<SystemPresence>> getSystempresencesAsync(GetSystempresencesRequest request,
 AsyncApiCallback<List<SystemPresence>> callback)

Get the list of SystemPresences

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getSystempresencesAsync

public Future<ApiResponse<List<SystemPresence>>> getSystempresencesAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<List<SystemPresence>>> callback)

Get the list of SystemPresences

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUserPresenceAsync

public Future<UserPresence> getUserPresenceAsync(GetUserPresenceRequest request,
 AsyncApiCallback<UserPresence> callback)

Get a user's Presence Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUserPresenceAsync

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

Get a user's Presence Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUserPresencesPurecloudAsync

public Future<UserPresence> getUserPresencesPurecloudAsync(GetUserPresencesPurecloudRequest request,
 AsyncApiCallback<UserPresence> callback)

Get a user's Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUserPresencesPurecloudAsync

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

Get a user's Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsersPresenceBulkAsync

public Future<List<UcUserPresence>> getUsersPresenceBulkAsync(GetUsersPresenceBulkRequest request,
 AsyncApiCallback<List<UcUserPresence>> callback)

Get bulk user presences for a single presence source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsersPresenceBulkAsync

public Future<ApiResponse<List<UcUserPresence>>> getUsersPresenceBulkAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<List<UcUserPresence>>> callback)

Get bulk user presences for a single presence source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsersPresencesPurecloudBulkAsync

public Future<List<UcUserPresence>> getUsersPresencesPurecloudBulkAsync(GetUsersPresencesPurecloudBulkRequest request,
 AsyncApiCallback<List<UcUserPresence>> callback)

Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsersPresencesPurecloudBulkAsync

public Future<ApiResponse<List<UcUserPresence>>> getUsersPresencesPurecloudBulkAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<List<UcUserPresence>>> callback)

Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchUserPresenceAsync

public Future<UserPresence> patchUserPresenceAsync(PatchUserPresenceRequest request,
 AsyncApiCallback<UserPresence> callback)

Patch a user's Presence Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchUserPresenceAsync

public Future<ApiResponse<UserPresence>> patchUserPresenceAsync(ApiRequest<UserPresence> request,
 AsyncApiCallback<ApiResponse<UserPresence>> callback)

Patch a user's Presence Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchUserPresencesPurecloudAsync

public Future<UserPresence> patchUserPresencesPurecloudAsync(PatchUserPresencesPurecloudRequest request,
 AsyncApiCallback<UserPresence> callback)

Patch a Genesys Cloud user's presence The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchUserPresencesPurecloudAsync

public Future<ApiResponse<UserPresence>> patchUserPresencesPurecloudAsync(ApiRequest<UserPresence> request,
 AsyncApiCallback<ApiResponse<UserPresence>> callback)

Patch a Genesys Cloud user's presence The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postPresenceDefinitions0Async

public Future<OrganizationPresenceDefinition> postPresenceDefinitions0Async(PostPresenceDefinitions0Request request,
 AsyncApiCallback<OrganizationPresenceDefinition> callback)

Create a Presence Definition

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postPresenceDefinitions0Async

public Future<ApiResponse<OrganizationPresenceDefinition>> postPresenceDefinitions0Async(ApiRequest<OrganizationPresenceDefinition> request,
 AsyncApiCallback<ApiResponse<OrganizationPresenceDefinition>> callback)

Create a Presence Definition

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postPresenceSourcesAsync

public Future<Source> postPresenceSourcesAsync(PostPresenceSourcesRequest request,
 AsyncApiCallback<Source> callback)

Create a Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postPresenceSourcesAsync

public Future<ApiResponse<Source>> postPresenceSourcesAsync(ApiRequest<Source> request,
 AsyncApiCallback<ApiResponse<Source>> callback)

Create a Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postPresencedefinitionsAsync

public Future<OrganizationPresence> postPresencedefinitionsAsync(PostPresencedefinitionsRequest request,
 AsyncApiCallback<OrganizationPresence> callback)

Deprecated.

Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postPresencedefinitionsAsync

public Future<ApiResponse<OrganizationPresence>> postPresencedefinitionsAsync(ApiRequest<OrganizationPresence> request,
 AsyncApiCallback<ApiResponse<OrganizationPresence>> callback)

Deprecated.

Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresenceDefinition0Async

public Future<OrganizationPresenceDefinition> putPresenceDefinition0Async(PutPresenceDefinition0Request request,
 AsyncApiCallback<OrganizationPresenceDefinition> callback)

Update a Presence Definition

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresenceDefinition0Async

public Future<ApiResponse<OrganizationPresenceDefinition>> putPresenceDefinition0Async(ApiRequest<OrganizationPresenceDefinition> request,
 AsyncApiCallback<ApiResponse<OrganizationPresenceDefinition>> callback)

Update a Presence Definition

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresenceSettingsAsync

public Future<PresenceSettings> putPresenceSettingsAsync(PutPresenceSettingsRequest request,
 AsyncApiCallback<PresenceSettings> callback)

Update the presence settings

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresenceSettingsAsync

public Future<ApiResponse<PresenceSettings>> putPresenceSettingsAsync(ApiRequest<PresenceSettings> request,
 AsyncApiCallback<ApiResponse<PresenceSettings>> callback)

Update the presence settings

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresenceSourceAsync

public Future<Source> putPresenceSourceAsync(PutPresenceSourceRequest request,
 AsyncApiCallback<Source> callback)

Update a Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresenceSourceAsync

public Future<ApiResponse<Source>> putPresenceSourceAsync(ApiRequest<Source> request,
 AsyncApiCallback<ApiResponse<Source>> callback)

Update a Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresenceUserPrimarysourceAsync

public Future<UserPrimarySource> putPresenceUserPrimarysourceAsync(PutPresenceUserPrimarysourceRequest request,
 AsyncApiCallback<UserPrimarySource> callback)

Update a user's Primary Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresenceUserPrimarysourceAsync

public Future<ApiResponse<UserPrimarySource>> putPresenceUserPrimarysourceAsync(ApiRequest<UserPrimarySource> request,
 AsyncApiCallback<ApiResponse<UserPrimarySource>> callback)

Update a user's Primary Presence Source

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresencedefinitionAsync

public Future<OrganizationPresence> putPresencedefinitionAsync(PutPresencedefinitionRequest request,
 AsyncApiCallback<OrganizationPresence> callback)

Deprecated.

Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putPresencedefinitionAsync

public Future<ApiResponse<OrganizationPresence>> putPresencedefinitionAsync(ApiRequest<OrganizationPresence> request,
 AsyncApiCallback<ApiResponse<OrganizationPresence>> callback)

Deprecated.

Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putUsersPresencesBulkAsync

public Future<List<UserPresence>> putUsersPresencesBulkAsync(PutUsersPresencesBulkRequest request,
 AsyncApiCallback<List<UserPresence>> callback)

Update bulk user Presences

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putUsersPresencesBulkAsync

public Future<ApiResponse<List<UserPresence>>> putUsersPresencesBulkAsync(ApiRequest<List<MutableUserPresence>> request,
 AsyncApiCallback<ApiResponse<List<UserPresence>>> callback)

Update bulk user Presences

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed