public class

AsyncUserGroup

extends UserGroup
java.lang.Object
   ↳ com.kinvey.java.UserGroup
     ↳ com.kinvey.android.AsyncUserGroup

Class Overview

/** Wraps the com.kinvey.java.UserGroup public methods in asynchronous functionality using native Android AsyncTask.

This functionality can be accessed through the userGroup() convenience method.

This API is used to create and manage user groups for role-based permissions. Methods in this API return results via a com.kinvey.java.core.KinveyClientCallback.

Sample Usage:

    public void submit(View view) {
        kinveyClient.userGroup().addUserToGroup("13", "15", null new KinveyClientCallback () {
            public void onFailure(Throwable t) { ... }
            public void onSuccess(UserGroupResponse u) { ... }
        });
    }
 

This class is not thread-safe.

Summary

Public Methods
<T> void addAllUsersToGroup(String groupID, String childGroupID, KinveyClientCallback<T> callback)
Asynchronous request to add all users to a specific group

Constructs an asynchronous request to add all users of an app to a user group.

<T> void addAllUsersToGroupList(String groupID, List<String> childGroupIDs, KinveyClientCallback<T> callback)
Asynchronous request to add all users to a list of user groups

Constructs an asynchronous request to add all users to a list of user group IDs.

<T> void addUserListToGroup(String groupID, List<String> userIDs, String childGroupID, KinveyClientCallback<T> callback)
Asynchronous request to add a list of users to a group

Constructs an asynchronous request to add a list of users to a particular user group.

<T> void addUserListToGroupList(String groupID, List<String> userIDs, List<String> childGroupIDs, KinveyClientCallback<T> callback)
Asynchronous request to add a user list to a list of groups

Constructs an asynchronous request to add a list of users to a list of user group IDs.

<T> void addUserToGroup(String groupID, String userID, String childGroupID, KinveyClientCallback<T> callback)
Asynchronous request to add user to a group

Constructs an asynchronous request to add a user to a particular user group.

<T> void addUserToGroupList(String groupID, String userID, List<String> childGroupID, KinveyClientCallback<T> callback)
Asynchronous request to add a user to a list of groups

Constructs an asynchronous request to add a user to a list of user group IDs.

<T> void create(UserGroup.UserGroupRequest group, KinveyClientCallback<T> callback)
Asynchronous request to create a user group

Constructs an asynchronous request to createa a user group.

<T> void delete(String groupID, KinveyClientCallback<T> callback)
Asynchronous request to delete a user group

Constructs an asynchronous request to delete a user group.

<T> void retrieve(String groupID, KinveyClientCallback<T> callback)
Asynchronous request to retrieve a user group

Constructs an asynchronous request to retrieve a user group.

<T> void update(UserGroup.UserGroupRequest group, KinveyClientCallback<T> callback)
Asynchronous request to update a user group

Constructs an asynchronous request to retrieve a user group.

[Expand]
Inherited Methods
From class com.kinvey.java.UserGroup
From class java.lang.Object

Public Methods

public void addAllUsersToGroup (String groupID, String childGroupID, KinveyClientCallback<T> callback)

Asynchronous request to add all users to a specific group

Constructs an asynchronous request to add all users of an app to a user group. Returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

 kinveyClient.userGroup().addAllUsersToGroup("13", "125", new KinveyClientCallback<UserGroupResponse>() {
            public void onFailure(Throwable t) { ... 
            public void onSuccess(UserGroupResponse r) { ... }
        });
    

Parameters
groupID a java.lang.String group ID to add all users to.
childGroupID a java.lang.String child group to add all users to.
callback a com.kinvey.java.core.KinveyClientCallback object.

public void addAllUsersToGroupList (String groupID, List<String> childGroupIDs, KinveyClientCallback<T> callback)

Asynchronous request to add all users to a list of user groups

Constructs an asynchronous request to add all users to a list of user group IDs. Returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

 kinveyClient.userGroup().addAllUsersToGroupList("13", myGroupIDs, new KinveyClientCallback<UserGroupResponse>() {
            public void onFailure(Throwable t) { ... 
            public void onSuccess(UserGroupResponse r) { ... }
        });
    }
     

Parameters
groupID a java.lang.String group ID to add all users to.
childGroupIDs a java.util.List list of child IDs to add all users to.
callback a KinveyClientCallback object.

public void addUserListToGroup (String groupID, List<String> userIDs, String childGroupID, KinveyClientCallback<T> callback)

Asynchronous request to add a list of users to a group

Constructs an asynchronous request to add a list of users to a particular user group. Returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

 kinveyClient.userGroup().addUserListToGroup("13", userIDList, null, new KinveyClientCallback<UserGroupResponse>() {
            public void onFailure(Throwable t) { ... 
            public void onSuccess(UserGroupResponse r) { ... }
        });
    }
 

Parameters
groupID a java.lang.String group ID to add list of users to.
userIDs a java.util.List of Strings containing userIDs to add to groups
childGroupID a java.lang.String object containing a child ID.
callback a KinveyClientCallback object.

public void addUserListToGroupList (String groupID, List<String> userIDs, List<String> childGroupIDs, KinveyClientCallback<T> callback)

Asynchronous request to add a user list to a list of groups

Constructs an asynchronous request to add a list of users to a list of user group IDs. Returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

     kinveyClient.userGroup().addUserListToGroupList("13", "125", myGroupList, new KinveyClientCallback<UserGroupResponse>() {
            public void onFailure(Throwable t) { ... 
            public void onSuccess(UserGroupResponse r) { ... }
        });
     }
     

Parameters
groupID a java.lang.String group ID to add users to.
userIDs a java.util.List of Strings containing User IDs.
childGroupIDs a java.util.List child group IDs.
callback a KinveyClientCallback object.

public void addUserToGroup (String groupID, String userID, String childGroupID, KinveyClientCallback<T> callback)

Asynchronous request to add user to a group

Constructs an asynchronous request to add a user to a particular user group. Returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

 kinveyClient.userGroup().addUserToGroup("13", "14", null, new KinveyClientCallback<UserGroupResponse>() {
            public void onFailure(Throwable t) { ... 
            public void onSuccess(UserGroupResponse r) { ... }
        });
    }
 

Parameters
groupID a java.lang.String group ID to add a user to.
userID a java.lang.String user ID to add to a group.
childGroupID a java.lang.String child group ID to add a user to.
callback a KinveyClientCallback object.

public void addUserToGroupList (String groupID, String userID, List<String> childGroupID, KinveyClientCallback<T> callback)

Asynchronous request to add a user to a list of groups

Constructs an asynchronous request to add a user to a list of user group IDs. Returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

 kinveyClient.userGroup().addUserToGroupList("13", "125", myGroupList, new KinveyClientCallback<UserGroupResponse>() {
            public void onFailure(Throwable t) { ... 
            public void onSuccess(UserGroupResponse r) { ... }
        });
    }
     

Parameters
groupID a java.lang.String group ID to add a user to.
userID a java.lang.String user ID to add.
childGroupID a java.util.List List of child group IDs.
callback a KinveyClientCallback object.

public void create (UserGroup.UserGroupRequest group, KinveyClientCallback<T> callback)

Asynchronous request to create a user group

Constructs an asynchronous request to createa a user group. Takes a UserGroupRequest object and returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

 UserGroup request = kinveyClient.userGroup().getUserGroupRequest(myGroupID, myChildGroupID);
        kinveyClient.userGroup().create(request, new KinveyClientCallback<UserGroupResponse>() {
            public void onFailure(Throwable t) { ... 
            public void onSuccess(UserGroupResponse r) { ... }
         });
    }
     

Parameters
group a UserGroupRequest object containing the group to create.
callback a KinveyClientCallback object.

public void delete (String groupID, KinveyClientCallback<T> callback)

Asynchronous request to delete a user group

Constructs an asynchronous request to delete a user group. Returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

 kinveyClient.userGroup().delete(reqeuest, new KinveyClientCallback<UserGroupResponse>() {
            public void onFailure(Throwable t) { ... 
            public void onSuccess(UserGroupResponse r) { ... }
        });
    }
     

Parameters
groupID a java.lang.String group ID to be deleted.
callback a KinveyClientCallback object.

public void retrieve (String groupID, KinveyClientCallback<T> callback)

Asynchronous request to retrieve a user group

Constructs an asynchronous request to retrieve a user group. Returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

     kinveyClient.userGroup().retrieve(myGroupID, new KinveyClientCallback<UserGroupResponse>() {
             public void onFailure(Throwable t) { ... 
             public void onSuccess(UserGroupResponse r) { ... }
     });
     }
     

Parameters
groupID a java.lang.String group ID to retrieve.
callback a KinveyClientCallback object.

public void update (UserGroup.UserGroupRequest group, KinveyClientCallback<T> callback)

Asynchronous request to update a user group

Constructs an asynchronous request to retrieve a user group. Returns a UserGroupResponse via a KinveyClientCallback.

Sample Usage:

 UserGroup request = kinveyClient.userGroup().getUserGroupRequest(myGroupID, myChildGroupID);
        kinveyClient.userGroup().update(reqeuest, new KinveyClientCallback<UserGroupResponse>() {
             public void onFailure(Throwable t) { ... 
             public void onSuccess(UserGroupResponse r) { ... }
        });
    

Parameters
group a UserGroupRequest containing the group to be updated.
callback a KinveyClientCallback object.