Package com.mypurecloud.sdk.v2.api

Class LocationsApiAsync

java.lang.Object

com.mypurecloud.sdk.v2.api.LocationsApiAsync

public class LocationsApiAsync
extends Object

Constructor Summary

Constructors

Constructor	Description
LocationsApiAsync()
LocationsApiAsync(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Future<Void>	deleteLocationAsync(DeleteLocationRequest request, AsyncApiCallback<Void> callback)	Delete a location
Future<ApiResponse<Void>>	deleteLocationAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete a location
Future<LocationDefinition>	getLocationAsync(GetLocationRequest request, AsyncApiCallback<LocationDefinition> callback)	Get Location by ID.
Future<ApiResponse<LocationDefinition>>	getLocationAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LocationDefinition>> callback)	Get Location by ID.
Future<LocationEntityListing>	getLocationsAsync(GetLocationsRequest request, AsyncApiCallback<LocationEntityListing> callback)	Get a list of all locations.
Future<ApiResponse<LocationEntityListing>>	getLocationsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LocationEntityListing>> callback)	Get a list of all locations.
Future<LocationsSearchResponse>	getLocationsSearchAsync(GetLocationsSearchRequest request, AsyncApiCallback<LocationsSearchResponse> callback)	Search locations using the q64 value returned from a previous search
Future<ApiResponse<LocationsSearchResponse>>	getLocationsSearchAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LocationsSearchResponse>> callback)	Search locations using the q64 value returned from a previous search
Future<LocationEntityListing>	getLocationSublocationsAsync(GetLocationSublocationsRequest request, AsyncApiCallback<LocationEntityListing> callback)	Get sublocations for location ID.
Future<ApiResponse<LocationEntityListing>>	getLocationSublocationsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LocationEntityListing>> callback)	Get sublocations for location ID.
Future<LocationDefinition>	patchLocationAsync(PatchLocationRequest request, AsyncApiCallback<LocationDefinition> callback)	Update a location
Future<ApiResponse<LocationDefinition>>	patchLocationAsync(ApiRequest<LocationUpdateDefinition> request, AsyncApiCallback<ApiResponse<LocationDefinition>> callback)	Update a location
Future<LocationDefinition>	postLocationsAsync(PostLocationsRequest request, AsyncApiCallback<LocationDefinition> callback)	Create a location
Future<ApiResponse<LocationDefinition>>	postLocationsAsync(ApiRequest<LocationCreateDefinition> request, AsyncApiCallback<ApiResponse<LocationDefinition>> callback)	Create a location
Future<LocationsSearchResponse>	postLocationsSearchAsync(PostLocationsSearchRequest request, AsyncApiCallback<LocationsSearchResponse> callback)	Search locations
Future<ApiResponse<LocationsSearchResponse>>	postLocationsSearchAsync(ApiRequest<LocationSearchRequest> request, AsyncApiCallback<ApiResponse<LocationsSearchResponse>> callback)	Search locations

Methods inherited from class java.lang.Object

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

Constructor Details

LocationsApiAsync

public LocationsApiAsync()

LocationsApiAsync

public LocationsApiAsync(ApiClient apiClient)

Method Details

deleteLocationAsync

public Future<Void> deleteLocationAsync(DeleteLocationRequest request,
 AsyncApiCallback<Void> callback)

Delete a location

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteLocationAsync

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

Delete a location

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLocationAsync

public Future<LocationDefinition> getLocationAsync(GetLocationRequest request,
 AsyncApiCallback<LocationDefinition> callback)

Get Location by ID.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLocationAsync

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

Get Location by ID.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLocationSublocationsAsync

public Future<LocationEntityListing> getLocationSublocationsAsync(GetLocationSublocationsRequest request,
 AsyncApiCallback<LocationEntityListing> callback)

Get sublocations for location ID.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLocationSublocationsAsync

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

Get sublocations for location ID.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLocationsAsync

public Future<LocationEntityListing> getLocationsAsync(GetLocationsRequest request,
 AsyncApiCallback<LocationEntityListing> callback)

Get a list of all locations.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLocationsAsync

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

Get a list of all locations.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLocationsSearchAsync

public Future<LocationsSearchResponse> getLocationsSearchAsync(GetLocationsSearchRequest request,
 AsyncApiCallback<LocationsSearchResponse> callback)

Search locations using the q64 value returned from a previous search

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLocationsSearchAsync

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

Search locations using the q64 value returned from a previous search

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLocationAsync

public Future<LocationDefinition> patchLocationAsync(PatchLocationRequest request,
 AsyncApiCallback<LocationDefinition> callback)

Update a location

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLocationAsync

public Future<ApiResponse<LocationDefinition>> patchLocationAsync(ApiRequest<LocationUpdateDefinition> request,
 AsyncApiCallback<ApiResponse<LocationDefinition>> callback)

Update a location

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLocationsAsync

public Future<LocationDefinition> postLocationsAsync(PostLocationsRequest request,
 AsyncApiCallback<LocationDefinition> callback)

Create a location

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLocationsAsync

public Future<ApiResponse<LocationDefinition>> postLocationsAsync(ApiRequest<LocationCreateDefinition> request,
 AsyncApiCallback<ApiResponse<LocationDefinition>> callback)

Create a location

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLocationsSearchAsync

public Future<LocationsSearchResponse> postLocationsSearchAsync(PostLocationsSearchRequest request,
 AsyncApiCallback<LocationsSearchResponse> callback)

Search locations

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLocationsSearchAsync

public Future<ApiResponse<LocationsSearchResponse>> postLocationsSearchAsync(ApiRequest<LocationSearchRequest> request,
 AsyncApiCallback<ApiResponse<LocationsSearchResponse>> callback)

Search locations

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed