com.files.models

Class Lock

java.lang.Object

com.files.models.Lock

All Implemented Interfaces:

ModelInterface

public class Lock
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	allowAccessByAnyUser Can lock be modified by users other than its creator?
String	depth
Boolean	exclusive Is lock exclusive?
String	owner Owner of the lock.
String	path Path.
Boolean	recursive Does lock apply to subfolders?
String	scope
Long	timeout Lock timeout in seconds
String	token Lock token.
String	type
Long	userId Lock creator user ID
String	username Lock creator username

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Lock	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Lock	create(String path, HashMap<String,Object> parameters) Parameters: path (required) - string - Path allow_access_by_any_user - boolean - Can lock be modified by users other than its creator?
static Lock	create(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete() Parameters: token (required) - string - Lock token
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(String path, HashMap<String,Object> parameters) Parameters: token (required) - string - Lock token
static void	delete(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Lock>	listFor() Parameters: cursor - string - Used for pagination.
static ListIterator<Lock>	listFor(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Lock>	listFor(String path, HashMap<String,Object> parameters)
static ListIterator<Lock>	listFor(String path, 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

path

public String path

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

timeout

public Long timeout

Lock timeout in seconds

depth

public String depth

recursive

public Boolean recursive

Does lock apply to subfolders?

owner

public String owner

Owner of the lock. This can be any arbitrary string.

scope

public String scope

exclusive

public Boolean exclusive

Is lock exclusive?

token

public String token

Lock token. Use to release lock.

type

public String type

allowAccessByAnyUser

public Boolean allowAccessByAnyUser

Can lock be modified by users other than its creator?

userId

public Long userId

Lock creator user ID

username

public String username

Lock creator username

Constructor Detail

Lock

public Lock()

Lock

public Lock(HashMap<String,Object> parameters)

Lock

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

Method Detail

delete

public void delete()
            throws IOException

Parameters: token (required) - string - Lock token

Throws:

IOException

destroy

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

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

listFor

public static ListIterator<Lock> listFor()
                                  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). path (required) - string - Path to operate on. include_children - boolean - Include locks from children objects?

Throws:

RuntimeException

listFor

public static ListIterator<Lock> listFor(String path,
                                         HashMap<String,Object> parameters)
                                  throws RuntimeException

Throws:

RuntimeException

listFor

public static ListIterator<Lock> listFor(HashMap<String,Object> parameters,
                                         HashMap<String,Object> options)
                                  throws RuntimeException

Throws:

RuntimeException

listFor

public static ListIterator<Lock> listFor(String path,
                                         HashMap<String,Object> parameters,
                                         HashMap<String,Object> options)
                                  throws RuntimeException

Throws:

RuntimeException

create

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

Parameters: path (required) - string - Path allow_access_by_any_user - boolean - Can lock be modified by users other than its creator? exclusive - boolean - Is lock exclusive? recursive - boolean - Does lock apply to subfolders? timeout - int64 - Lock timeout in seconds

Throws:

RuntimeException

create

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

Throws:

RuntimeException

create

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

Throws:

RuntimeException

delete

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

Parameters: token (required) - string - Lock token

Throws:

RuntimeException

delete

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

Throws:

RuntimeException

delete

public static void delete(String path,
                          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(String path,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException