com.files.models

Class ShareGroup

java.lang.Object

com.files.models.ShareGroup

All Implemented Interfaces:

ModelInterface

public class ShareGroup
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Long	id Share Group ID
Object[]	members A list of share group members
String	name Name of the share group
String	notes Additional notes of the share group
Long	userId Owner User ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<ShareGroup>	all()
static ListIterator<ShareGroup>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ShareGroup	create(HashMap<String,Object> parameters) Parameters: user_id - int64 - User ID.
static ShareGroup	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 ShareGroup	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ShareGroup	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Share Group ID.
static ShareGroup	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ShareGroup	get()
static ShareGroup	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<ShareGroup>	list() Parameters: user_id - int64 - User ID.
static ListIterator<ShareGroup>	list(HashMap<String,Object> parameters)
static ListIterator<ShareGroup>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
ShareGroup	update() Parameters: notes - string - Additional notes of the share group name - string - Name of the share group members - array(object) - A list of share group members.
static ShareGroup	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ShareGroup	update(Long id, HashMap<String,Object> parameters) Parameters: notes - string - Additional notes of the share group name - string - Name of the share group members - array(object) - A list of share group members.
static ShareGroup	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

Share Group ID

name

public String name

Name of the share group

notes

public String notes

Additional notes of the share group

userId

public Long userId

Owner User ID

members

public Object[] members

A list of share group members

Constructor Detail

ShareGroup

public ShareGroup()

ShareGroup

public ShareGroup(HashMap<String,Object> parameters)

ShareGroup

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

Method Detail

update

public ShareGroup update()
                  throws IOException

Parameters: notes - string - Additional notes of the share group name - string - Name of the share group members - array(object) - A list of share group members.

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

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. 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).

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<ShareGroup> all()
                                    throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

find

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

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

get

public static ShareGroup get()
                      throws RuntimeException

Throws:

RuntimeException

get

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

Throws:

RuntimeException

create

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

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. notes - string - Additional notes of the share group name (required) - string - Name of the share group members (required) - array(object) - A list of share group members.

Throws:

RuntimeException

create

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

Throws:

RuntimeException

update

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

Parameters: notes - string - Additional notes of the share group name - string - Name of the share group members - array(object) - A list of share group members.

Throws:

RuntimeException

update

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

Throws:

RuntimeException

update

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