Package com.mypurecloud.sdk.v2.api

Class GroupsApiAsync

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

  • Constructor Details

    • GroupsApiAsync

      public GroupsApiAsync()

    • GroupsApiAsync

      public GroupsApiAsync(ApiClient apiClient)

  • Method Details

    • deleteGroupAsync

      public Future<Void> deleteGroupAsync(DeleteGroupRequest request, AsyncApiCallback<Void> callback)
      Delete group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteGroupAsync

      public Future<ApiResponse<Void>> deleteGroupAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Delete group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteGroupDynamicsettingsAsync

      public Future<Void> deleteGroupDynamicsettingsAsync(DeleteGroupDynamicsettingsRequest request, AsyncApiCallback<Void> callback)
      Remove dynamic group definition deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteGroupDynamicsettingsAsync

      public Future<ApiResponse<Void>> deleteGroupDynamicsettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Remove dynamic group definition deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteGroupMembersAsync

      public Future<Empty> deleteGroupMembersAsync(DeleteGroupMembersRequest request, AsyncApiCallback<Empty> callback)
      Remove members
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • deleteGroupMembersAsync

      public Future<ApiResponse<Empty>> deleteGroupMembersAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Empty>> callback)
      Remove members
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getFieldconfigAsync

      public Future<FieldConfig> getFieldconfigAsync(GetFieldconfigRequest request, AsyncApiCallback<FieldConfig> callback)
      Deprecated.
      Fetch field config for an entity type
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getFieldconfigAsync

      public Future<ApiResponse<FieldConfig>> getFieldconfigAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<FieldConfig>> callback)
      Deprecated.
      Fetch field config for an entity type
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGroupAsync

      public Future<Group> getGroupAsync(GetGroupRequest request, AsyncApiCallback<Group> callback)
      Get group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGroupAsync

      public Future<ApiResponse<Group>> getGroupAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Group>> callback)
      Get group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGroupDynamicsettingsAsync

      public Future<DynamicGroupDefinition> getGroupDynamicsettingsAsync(GetGroupDynamicsettingsRequest request, AsyncApiCallback<DynamicGroupDefinition> callback)
      Get dynamic group definition getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGroupDynamicsettingsAsync

      public Future<ApiResponse<DynamicGroupDefinition>> getGroupDynamicsettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<DynamicGroupDefinition>> callback)
      Get dynamic group definition getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGroupIndividualsAsync

      public Future<UserEntityListing> getGroupIndividualsAsync(GetGroupIndividualsRequest request, AsyncApiCallback<UserEntityListing> callback)
      Get all individuals associated with the group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGroupIndividualsAsync

      public Future<ApiResponse<UserEntityListing>> getGroupIndividualsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserEntityListing>> callback)
      Get all individuals associated with the group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGroupMembersAsync

      public Future<UserEntityListing> getGroupMembersAsync(GetGroupMembersRequest request, AsyncApiCallback<UserEntityListing> callback)
      Get group members, includes individuals, owners, and dynamically included people
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGroupMembersAsync

      public Future<ApiResponse<UserEntityListing>> getGroupMembersAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserEntityListing>> callback)
      Get group members, includes individuals, owners, and dynamically included people
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • getGroupProfileAsync

      public Future<GroupProfile> getGroupProfileAsync(GetGroupProfileRequest request, AsyncApiCallback<GroupProfile> callback)
      Deprecated.
      Get group profile This api is deprecated. Use /api/v2/groups 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

    • getGroupProfileAsync

      public Future<ApiResponse<GroupProfile>> getGroupProfileAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GroupProfile>> callback)
      Deprecated.
      Get group profile This api is deprecated. Use /api/v2/groups 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

    • getGroupsAsync

      public Future<GroupEntityListing> getGroupsAsync(GetGroupsRequest request, AsyncApiCallback<GroupEntityListing> callback)
      Get a group 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

    • getGroupsAsync

      public Future<ApiResponse<GroupEntityListing>> getGroupsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GroupEntityListing>> callback)
      Get a group 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

    • getGroupsSearchAsync

      public Future<GroupsSearchResponse> getGroupsSearchAsync(GetGroupsSearchRequest request, AsyncApiCallback<GroupsSearchResponse> callback)
      Search groups 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

    • getGroupsSearchAsync

      public Future<ApiResponse<GroupsSearchResponse>> getGroupsSearchAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GroupsSearchResponse>> callback)
      Search groups 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

    • getProfilesGroupsAsync

      public Future<GroupProfileEntityListing> getProfilesGroupsAsync(GetProfilesGroupsRequest request, AsyncApiCallback<GroupProfileEntityListing> callback)
      Deprecated.
      Get group profile listing This api is deprecated. Use /api/v2/groups 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

    • getProfilesGroupsAsync

      public Future<ApiResponse<GroupProfileEntityListing>> getProfilesGroupsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GroupProfileEntityListing>> callback)
      Deprecated.
      Get group profile listing This api is deprecated. Use /api/v2/groups 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

    • postGroupMembersAsync

      public Future<Empty> postGroupMembersAsync(PostGroupMembersRequest request, AsyncApiCallback<Empty> callback)
      Add members
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postGroupMembersAsync

      public Future<ApiResponse<Empty>> postGroupMembersAsync(ApiRequest<GroupMembersUpdate> request, AsyncApiCallback<ApiResponse<Empty>> callback)
      Add members
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postGroupsAsync

      public Future<Group> postGroupsAsync(PostGroupsRequest request, AsyncApiCallback<Group> callback)
      Create a group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postGroupsAsync

      public Future<ApiResponse<Group>> postGroupsAsync(ApiRequest<GroupCreate> request, AsyncApiCallback<ApiResponse<Group>> callback)
      Create a group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postGroupsDynamicsettingsPreviewAsync

      public Future<DynamicGroupQueryPreview> postGroupsDynamicsettingsPreviewAsync(PostGroupsDynamicsettingsPreviewRequest request, AsyncApiCallback<DynamicGroupQueryPreview> callback)
      Deprecated.
      Preview the number of users selected for a dynamic group definition query postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postGroupsDynamicsettingsPreviewAsync

      public Future<ApiResponse<DynamicGroupQueryPreview>> postGroupsDynamicsettingsPreviewAsync(ApiRequest<DynamicGroupQuery> request, AsyncApiCallback<ApiResponse<DynamicGroupQueryPreview>> callback)
      Deprecated.
      Preview the number of users selected for a dynamic group definition query postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postGroupsSearchAsync

      public Future<GroupsSearchResponse> postGroupsSearchAsync(PostGroupsSearchRequest request, AsyncApiCallback<GroupsSearchResponse> callback)
      Search groups
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • postGroupsSearchAsync

      public Future<ApiResponse<GroupsSearchResponse>> postGroupsSearchAsync(ApiRequest<GroupSearchRequest> request, AsyncApiCallback<ApiResponse<GroupsSearchResponse>> callback)
      Search groups
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putGroupAsync

      public Future<Group> putGroupAsync(PutGroupRequest request, AsyncApiCallback<Group> callback)
      Update group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putGroupAsync

      public Future<ApiResponse<Group>> putGroupAsync(ApiRequest<GroupUpdate> request, AsyncApiCallback<ApiResponse<Group>> callback)
      Update group
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putGroupDynamicsettingsAsync

      public Future<Void> putGroupDynamicsettingsAsync(PutGroupDynamicsettingsRequest request, AsyncApiCallback<Void> callback)
      Create / Update dynamic group definition putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed

    • putGroupDynamicsettingsAsync

      public Future<ApiResponse<Void>> putGroupDynamicsettingsAsync(ApiRequest<DynamicGroupQuery> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Create / Update dynamic group definition putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed