Package com.mypurecloud.sdk.v2.api

Class GeolocationApiAsync

java.lang.Object
com.mypurecloud.sdk.v2.api.GeolocationApiAsync
public class GeolocationApiAsync extends Object

  • Constructor Details

    • GeolocationApiAsync

      public GeolocationApiAsync()

    • GeolocationApiAsync

      public GeolocationApiAsync(ApiClient apiClient)

  • Method Details

    • getGeolocationsSettingsAsync

      public Future<GeolocationSettings> getGeolocationsSettingsAsync(GetGeolocationsSettingsRequest request, AsyncApiCallback<GeolocationSettings> callback)
      Get a organization's GeolocationSettings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGeolocationsSettingsAsync

      public Future<ApiResponse<GeolocationSettings>> getGeolocationsSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GeolocationSettings>> callback)
      Get a organization's GeolocationSettings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getUserGeolocationAsync

      public Future<Geolocation> getUserGeolocationAsync(GetUserGeolocationRequest request, AsyncApiCallback<Geolocation> callback)
      Get a user's Geolocation
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getUserGeolocationAsync

      public Future<ApiResponse<Geolocation>> getUserGeolocationAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Geolocation>> callback)
      Get a user's Geolocation
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • patchGeolocationsSettingsAsync

      public Future<GeolocationSettings> patchGeolocationsSettingsAsync(PatchGeolocationsSettingsRequest request, AsyncApiCallback<GeolocationSettings> callback)
      Patch a organization's GeolocationSettings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • patchGeolocationsSettingsAsync

      public Future<ApiResponse<GeolocationSettings>> patchGeolocationsSettingsAsync(ApiRequest<GeolocationSettings> request, AsyncApiCallback<ApiResponse<GeolocationSettings>> callback)
      Patch a organization's GeolocationSettings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • patchUserGeolocationAsync

      public Future<Geolocation> patchUserGeolocationAsync(PatchUserGeolocationRequest request, AsyncApiCallback<Geolocation> callback)
      Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • patchUserGeolocationAsync

      public Future<ApiResponse<Geolocation>> patchUserGeolocationAsync(ApiRequest<Geolocation> request, AsyncApiCallback<ApiResponse<Geolocation>> callback)
      Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed