com.files.models

Class FileComment

java.lang.Object

com.files.models.FileComment

All Implemented Interfaces:

ModelInterface

public class FileComment
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	body Comment body.
Long	id File Comment ID
String	path File path.
Object[]	reactions Reactions to this comment.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FileComment	create(HashMap<String,Object> parameters) Parameters: body (required) - string - Comment body.
static FileComment	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<FileComment>	listFor() Parameters: cursor - string - Used for pagination.
static ListIterator<FileComment>	listFor(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<FileComment>	listFor(String path, HashMap<String,Object> parameters)
static ListIterator<FileComment>	listFor(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
FileComment	update() Parameters: body (required) - string - Comment body.
static FileComment	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static FileComment	update(Long id, HashMap<String,Object> parameters) Parameters: body (required) - string - Comment body.
static FileComment	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

File Comment ID

body

public String body

Comment body.

reactions

public Object[] reactions

Reactions to this comment.

path

public String path

File path.

Constructor Detail

FileComment

public FileComment()

FileComment

public FileComment(HashMap<String,Object> parameters)

FileComment

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

Method Detail

update

public FileComment update()
                   throws IOException

Parameters: body (required) - string - Comment body.

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

listFor

public static ListIterator<FileComment> 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.

Throws:

RuntimeException

listFor

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

Throws:

RuntimeException

listFor

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

Throws:

RuntimeException

listFor

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

Throws:

RuntimeException

create

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

Parameters: body (required) - string - Comment body. path (required) - string - File path.

Throws:

RuntimeException

create

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

Throws:

RuntimeException

update

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

Parameters: body (required) - string - Comment body.

Throws:

RuntimeException

update

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

Throws:

RuntimeException

update

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