com.files.models

Class History

java.lang.Object

com.files.models.History

All Implemented Interfaces:

ModelInterface

public class History
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	action Type of action
String	destination The destination path for this action, if applicable
String	display Friendly displayed output
String	failureType Failure type.
Long	id Action ID
String	interfaceName Interface on which this action occurred.
String	ip IP Address that performed this action
String	path Path.
String	source The source path for this action, if applicable
Map<String,String>	targets Targets
Long	userId User ID
Boolean	userIsFromParentSite true if this change was performed by a user on a parent site.
String	username Username
Date	when Action occurrence date/time

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<Action>	all()
static ListIterator<Action>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Action>	list() Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries.
static ListIterator<Action>	list(HashMap<String,Object> parameters)
static ListIterator<Action>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Action>	listForFile() Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries.
static ListIterator<Action>	listForFile(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Action>	listForFile(String path, HashMap<String,Object> parameters)
static ListIterator<Action>	listForFile(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Action>	listForFolder() Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries.
static ListIterator<Action>	listForFolder(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Action>	listForFolder(String path, HashMap<String,Object> parameters)
static ListIterator<Action>	listForFolder(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Action>	listForUser() Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries.
static ListIterator<Action>	listForUser(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Action>	listForUser(Long user_id, HashMap<String,Object> parameters)
static ListIterator<Action>	listForUser(Long user_id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Action>	listLogins() Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries.
static ListIterator<Action>	listLogins(HashMap<String,Object> parameters)
static ListIterator<Action>	listLogins(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

Action 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.

when

public Date when

Action occurrence date/time

destination

public String destination

The destination path for this action, if applicable

display

public String display

Friendly displayed output

ip

public String ip

IP Address that performed this action

source

public String source

The source path for this action, if applicable

targets

public Map<String,String> targets

Targets

userId

public Long userId

User ID

username

public String username

Username

userIsFromParentSite

public Boolean userIsFromParentSite

true if this change was performed by a user on a parent site.

action

public String action

Type of action

failureType

public String failureType

Failure type. If action was a user login or session failure, why did it fail?

interfaceName

public String interfaceName

Interface on which this action occurred.

Constructor Detail

History

public History()

History

public History(HashMap<String,Object> parameters)

History

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

Method Detail

listForFile

public static ListIterator<Action> listForFile()
                                        throws RuntimeException

Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries. end_at - string - Leave blank or set to a date/time to filter later entries. display - string - Display format. Leave blank or set to `full` or `parent`. 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 `path` and `created_at`. path (required) - string - Path to operate on.

Throws:

RuntimeException

listForFile

public static ListIterator<Action> listForFile(String path,
                                               HashMap<String,Object> parameters)
                                        throws RuntimeException

Throws:

RuntimeException

listForFile

public static ListIterator<Action> listForFile(HashMap<String,Object> parameters,
                                               HashMap<String,Object> options)
                                        throws RuntimeException

Throws:

RuntimeException

listForFile

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

Throws:

RuntimeException

listForFolder

public static ListIterator<Action> listForFolder()
                                          throws RuntimeException

Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries. end_at - string - Leave blank or set to a date/time to filter later entries. display - string - Display format. Leave blank or set to `full` or `parent`. 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 `created_at`. path (required) - string - Path to operate on.

Throws:

RuntimeException

listForFolder

public static ListIterator<Action> listForFolder(String path,
                                                 HashMap<String,Object> parameters)
                                          throws RuntimeException

Throws:

RuntimeException

listForFolder

public static ListIterator<Action> listForFolder(HashMap<String,Object> parameters,
                                                 HashMap<String,Object> options)
                                          throws RuntimeException

Throws:

RuntimeException

listForFolder

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

Throws:

RuntimeException

listForUser

public static ListIterator<Action> listForUser()
                                        throws RuntimeException

Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries. end_at - string - Leave blank or set to a date/time to filter later entries. display - string - Display format. Leave blank or set to `full` or `parent`. 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 `user_id` and `created_at`. user_id (required) - int64 - User ID.

Throws:

RuntimeException

listForUser

public static ListIterator<Action> listForUser(Long user_id,
                                               HashMap<String,Object> parameters)
                                        throws RuntimeException

Throws:

RuntimeException

listForUser

public static ListIterator<Action> listForUser(HashMap<String,Object> parameters,
                                               HashMap<String,Object> options)
                                        throws RuntimeException

Throws:

RuntimeException

listForUser

public static ListIterator<Action> listForUser(Long user_id,
                                               HashMap<String,Object> parameters,
                                               HashMap<String,Object> options)
                                        throws RuntimeException

Throws:

RuntimeException

listLogins

public static ListIterator<Action> listLogins()
                                       throws RuntimeException

Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries. end_at - string - Leave blank or set to a date/time to filter later entries. display - string - Display format. Leave blank or set to `full` or `parent`. 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 `created_at`.

Throws:

RuntimeException

listLogins

public static ListIterator<Action> listLogins(HashMap<String,Object> parameters)
                                       throws RuntimeException

Throws:

RuntimeException

listLogins

public static ListIterator<Action> listLogins(HashMap<String,Object> parameters,
                                              HashMap<String,Object> options)
                                       throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<Action> list()
                                 throws RuntimeException

Parameters: start_at - string - Leave blank or set to a date/time to filter earlier entries. end_at - string - Leave blank or set to a date/time to filter later entries. display - string - Display format. Leave blank or set to `full` or `parent`. 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 `path`, `created_at` or `user_id`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`. Valid field combinations are `[ user_id, folder ]`, `[ user_id, path ]`, `[ folder, path ]` or `[ user_id, folder, path ]`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<Action> all()
                                throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException