com.files.models

Class Group

java.lang.Object

com.files.models.Group

All Implemented Interfaces:

ModelInterface

public class Group
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	adminIds Comma-delimited list of user IDs who are group administrators (separated by commas)
String	allowedIps A list of allowed IPs if applicable.
Boolean	davPermission If true, users in this group can use WebDAV to login.
Boolean	ftpPermission If true, users in this group can use FTP to login.
Long	id Group ID
String	name Group name
String	notes Notes about this group
Boolean	restapiPermission If true, users in this group can use the REST API to login.
Boolean	sftpPermission If true, users in this group can use SFTP to login.
String	userIds Comma-delimited list of user IDs who belong to this group (separated by commas)
String	usernames Comma-delimited list of usernames who belong to this group (separated by commas)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<Group>	all()
static ListIterator<Group>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Group	create(HashMap<String,Object> parameters) Parameters: notes - string - Group notes.
static Group	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete()
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters)
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 Group	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Group	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Group ID.
static Group	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Group	get()
static Group	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Group>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<Group>	list(HashMap<String,Object> parameters)
static ListIterator<Group>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
Group	update() Parameters: notes - string - Group notes.
static Group	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Group	update(Long id, HashMap<String,Object> parameters) Parameters: notes - string - Group notes.
static Group	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

id

public Long id

Group ID

name

public String name

Group name

allowedIps

public String allowedIps

A list of allowed IPs if applicable. Newline delimited

adminIds

public String adminIds

Comma-delimited list of user IDs who are group administrators (separated by commas)

notes

public String notes

Notes about this group

userIds

public String userIds

Comma-delimited list of user IDs who belong to this group (separated by commas)

usernames

public String usernames

Comma-delimited list of usernames who belong to this group (separated by commas)

ftpPermission

public Boolean ftpPermission

If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.

sftpPermission

public Boolean sftpPermission

If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.

davPermission

public Boolean davPermission

If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.

restapiPermission

public Boolean restapiPermission

If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.

Constructor Detail

Group

public Group()

Group

public Group(HashMap<String,Object> parameters)

Group

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

Method Detail

update

public Group update()
             throws IOException

Parameters: notes - string - Group notes. user_ids - string - A list of user ids. If sent as a string, should be comma-delimited. admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited. ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level. sftp_permission - boolean - If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level. dav_permission - boolean - If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level. restapi_permission - boolean - If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level. allowed_ips - string - A list of allowed IPs if applicable. Newline delimited name - string - Group name.

Throws:

IOException

delete

public void delete()
            throws IOException

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<Group> list()
                                throws RuntimeException

Parameters: 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). sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`. ids - string - Comma-separated list of group ids to include in results.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<Group> all()
                               throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

find

public static Group find(Long id,
                         HashMap<String,Object> parameters)
                  throws RuntimeException

Parameters: id (required) - int64 - Group ID.

Throws:

RuntimeException

find

public static Group find(HashMap<String,Object> parameters,
                         HashMap<String,Object> options)
                  throws RuntimeException

Throws:

RuntimeException

find

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

Throws:

RuntimeException

get

public static Group get()
                 throws RuntimeException

Throws:

RuntimeException

get

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

Throws:

RuntimeException

create

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

Parameters: notes - string - Group notes. user_ids - string - A list of user ids. If sent as a string, should be comma-delimited. admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited. ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level. sftp_permission - boolean - If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level. dav_permission - boolean - If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level. restapi_permission - boolean - If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level. allowed_ips - string - A list of allowed IPs if applicable. Newline delimited name (required) - string - Group name.

Throws:

RuntimeException

create

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

Throws:

RuntimeException

update

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

Parameters: notes - string - Group notes. user_ids - string - A list of user ids. If sent as a string, should be comma-delimited. admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited. ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level. sftp_permission - boolean - If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level. dav_permission - boolean - If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level. restapi_permission - boolean - If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level. allowed_ips - string - A list of allowed IPs if applicable. Newline delimited name - string - Group name.

Throws:

RuntimeException

update

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

Throws:

RuntimeException

update

public static Group 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

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