API Reference

Method Detail

• addUserToGroup

  public void addUserToGroup(java.lang.String groupID,
                             java.lang.String userID,
                             java.lang.String childGroupID,
                             com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  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 com.kinvey.java.core.KinveyClientCallback object.

• addUserListToGroup

  public void addUserListToGroup(java.lang.String groupID,
                                 java.util.List<java.lang.String> userIDs,
                                 java.lang.String childGroupID,
                                 com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  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 com.kinvey.java.core.KinveyClientCallback object.

• addUserToGroupList

  public void addUserToGroupList(java.lang.String groupID,
                                 java.lang.String userID,
                                 java.util.List<java.lang.String> childGroupID,
                                 com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  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 com.kinvey.java.core.KinveyClientCallback object.

• addUserListToGroupList

  public void addUserListToGroupList(java.lang.String groupID,
                                     java.util.List<java.lang.String> userIDs,
                                     java.util.List<java.lang.String> childGroupIDs,
                                     com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  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 com.kinvey.java.core.KinveyClientCallback object.

• addAllUsersToGroup

  public void addAllUsersToGroup(java.lang.String groupID,
                                 java.lang.String childGroupID,
                                 com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  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. a T object.`

• addAllUsersToGroupList

  public void addAllUsersToGroupList(java.lang.String groupID,
                                     java.util.List<java.lang.String> childGroupIDs,
                                     com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  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 com.kinvey.java.core.KinveyClientCallback object.

• create

  public void create(com.kinvey.java.UserGroup.UserGroupRequest group,
                     com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  Parameters:

  group - a UserGroupRequest object containing the group to create.

  callback - a com.kinvey.java.core.KinveyClientCallback object.

• retrieve

  public void retrieve(java.lang.String groupID,
                       com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  Parameters:

  groupID - a java.lang.String group ID to retrieve.

  callback - a com.kinvey.java.core.KinveyClientCallback object.

• update

  public void update(com.kinvey.java.UserGroup.UserGroupRequest group,
                     com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  group a UserGroupRequest containing the group to be updated. callback a { com.kinvey.java.core.KinveyClientCallback} object. a T object.`

• delete

  public void delete(java.lang.String groupID,
                     com.kinvey.java.core.KinveyClientCallback<com.kinvey.java.UserGroup.UserGroupResponse> 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:

  Parameters:

  groupID - a java.lang.String group ID to be deleted.

  callback - a com.kinvey.java.core.KinveyClientCallback object.