com.files.models

Class GroupUser

java.lang.Object

com.files.models.GroupUser

All Implemented Interfaces:

ModelInterface

public class GroupUser
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	admin Is this user an administrator of this group?
Long	groupId Group ID
String	groupName Group name
Long	id Group User ID.
Long	userId User ID
String[]	usernames A list of usernames for users in this group

Constructor Summary

Constructors

Constructor and Description
GroupUser()
GroupUser(HashMap<String,Object> parameters)
GroupUser(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<GroupUser>	all()
static ListIterator<GroupUser>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static GroupUser	create(HashMap<String,Object> parameters) Parameters: group_id (required) - int64 - Group ID to add user to.
static GroupUser	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete() Parameters: group_id (required) - int64 - Group ID from which to remove user.
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters) Parameters: group_id (required) - int64 - Group ID from which to remove user.
static void	delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<GroupUser>	list() Parameters: user_id - int64 - User ID.
static ListIterator<GroupUser>	list(HashMap<String,Object> parameters)
static ListIterator<GroupUser>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
GroupUser	update() Parameters: group_id (required) - int64 - Group ID to add user to.
static GroupUser	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static GroupUser	update(Long id, HashMap<String,Object> parameters) Parameters: group_id (required) - int64 - Group ID to add user to.
static GroupUser	update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

groupName

public String groupName

Group name

groupId

public Long groupId

Group ID

userId

public Long userId

User ID

admin

public Boolean admin

Is this user an administrator of this group?

usernames

public String[] usernames

A list of usernames for users in this group

id

public Long id

Group User ID.

Constructor Detail

GroupUser

public GroupUser()

GroupUser

public GroupUser(HashMap<String,Object> parameters)

GroupUser

public GroupUser(HashMap<String,Object> parameters,
                 HashMap<String,Object> options)

Method Detail

update

public GroupUser update()
                 throws IOException

Parameters: group_id (required) - int64 - Group ID to add user to. user_id (required) - int64 - User ID to add to group. admin - boolean - Is the user a group administrator?

Throws:

IOException

delete

public void delete()
            throws IOException

Parameters: group_id (required) - int64 - Group ID from which to remove user. user_id (required) - int64 - User ID to remove from group.

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<GroupUser> list()
                                    throws RuntimeException

Parameters: user_id - int64 - User ID. If provided, will return group_users of this user. cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). group_id - int64 - Group ID. If provided, will return group_users of this group.

Throws:

RuntimeException

list

public static ListIterator<GroupUser> list(HashMap<String,Object> parameters)
                                    throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<GroupUser> list(HashMap<String,Object> parameters,
                                           HashMap<String,Object> options)
                                    throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<GroupUser> all()
                                   throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<GroupUser> all(HashMap<String,Object> parameters,
                                          HashMap<String,Object> options)
                                   throws RuntimeException

Throws:

RuntimeException

create

public static GroupUser create(HashMap<String,Object> parameters)
                        throws RuntimeException

Parameters: group_id (required) - int64 - Group ID to add user to. user_id (required) - int64 - User ID to add to group. admin - boolean - Is the user a group administrator?

Throws:

RuntimeException

create

public static GroupUser create(HashMap<String,Object> parameters,
                               HashMap<String,Object> options)
                        throws RuntimeException

Throws:

RuntimeException

update

public static GroupUser update(Long id,
                               HashMap<String,Object> parameters)
                        throws RuntimeException

Parameters: group_id (required) - int64 - Group ID to add user to. user_id (required) - int64 - User ID to add to group. admin - boolean - Is the user a group administrator?

Throws:

RuntimeException

update

public static GroupUser update(HashMap<String,Object> parameters,
                               HashMap<String,Object> options)
                        throws RuntimeException

Throws:

RuntimeException

update

public static GroupUser update(Long id,
                               HashMap<String,Object> parameters,
                               HashMap<String,Object> options)
                        throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Parameters: group_id (required) - int64 - Group ID from which to remove user. user_id (required) - int64 - User ID to remove from group.

Throws:

RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy()
                    throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException