com.files.models

Class Permission

java.lang.Object

com.files.models.Permission

All Implemented Interfaces:

ModelInterface

public class Permission
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Long	groupId Group ID
String	groupName Group name (if applicable)
Long	id Permission ID
String	path Path.
String	permission Permission type.
Boolean	recursive Recursive: does this permission apply to subfolders?
Long	userId User ID
String	username Username (if applicable)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<Permission>	all()
static ListIterator<Permission>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Permission	create(HashMap<String,Object> parameters) Parameters: path (required) - string - Folder path group_id - int64 - Group ID.
static Permission	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 ListIterator<Permission>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<Permission>	list(HashMap<String,Object> parameters)
static ListIterator<Permission>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()

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

Permission ID

path

public String path

Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.

userId

public Long userId

User ID

username

public String username

Username (if applicable)

groupId

public Long groupId

Group ID

groupName

public String groupName

Group name (if applicable)

permission

public String permission

Permission type. See the table referenced in the documentation for an explanation of each permission.

recursive

public Boolean recursive

Recursive: does this permission apply to subfolders?

Constructor Detail

Permission

public Permission()

Permission

public Permission(HashMap<String,Object> parameters)

Permission

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

Method Detail

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<Permission> 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 `group_id`, `path` or `user_id`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ path, group_id ]`, `[ path, user_id ]` or `[ group_id, user_id ]`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`. path - string - Permission path. If provided, will scope all permissions(including upward) to this path. include_groups - boolean - If searching by user or group, also include user's permissions that are inherited from its groups? group_id - string user_id - string

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<Permission> all()
                                    throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

create

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

Parameters: path (required) - string - Folder path group_id - int64 - Group ID. Provide `group_name` or `group_id` permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history` recursive - boolean - Apply to subfolders recursively? user_id - int64 - User ID. Provide `username` or `user_id` username - string - User username. Provide `username` or `user_id` group_name - string - Group name. Provide `group_name` or `group_id`

Throws:

RuntimeException

create

public static Permission create(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