com.box.sdk

Class BoxCollaborationWhitelistExemptTarget

Object

BoxResource

BoxCollaborationWhitelistExemptTarget

@BoxResourceType(value="collaboration_whitelist_exempt_target")
public class BoxCollaborationWhitelistExemptTarget
extends BoxResource

Represents a collaboration whitelist between a user and a Box Enterprise. Collaboration Whitelist enables a Box Enterprise(only available if you have Box Governance) to manage a set of approved users that can collaborate with an enterprise.

Unless otherwise noted, the methods in this class can throw an unchecked BoxAPIException (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxCollaborationWhitelistExemptTarget.Info Contains information about a BoxCollaborationWhitelistExemptTarget.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	COLLABORATION_WHITELIST_EXEMPT_TARGET_ENTRIES_URL_TEMPLATE Collaboration Whitelist Exempt Target Entries URL Template.
static URLTemplate	COLLABORATION_WHITELIST_EXEMPT_TARGET_ENTRY_URL_TEMPLATE Collaboration Whitelist Exempt Target Entries URL Template with given ID.

Constructor Summary

Constructors

Constructor and Description
BoxCollaborationWhitelistExemptTarget(BoxAPIConnection api, String id) Constructs a BoxCollaborationWhitelistExemptTarget for a collaboration whitelist with a give ID.

Method Summary

Modifier and Type	Method and Description
static BoxCollaborationWhitelistExemptTarget.Info	create(BoxAPIConnection api, String userID) Creates a collaboration whitelist for a Box User with a given ID.
void	delete() Deletes this collaboration whitelist entry for user.
static Iterable<BoxCollaborationWhitelistExemptTarget.Info>	getAll(BoxAPIConnection api, int limit, String... fields) Returns all the collaboration whitelisting for user with specified filters.
static Iterable<BoxCollaborationWhitelistExemptTarget.Info>	getAll(BoxAPIConnection api, String... fields) Returns all the collaboration whitelisting for user with default limit set to 100.
BoxCollaborationWhitelistExemptTarget.Info	getInfo() Retrieves information for a collaboration whitelist for a given whitelist ID.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

COLLABORATION_WHITELIST_EXEMPT_TARGET_ENTRIES_URL_TEMPLATE

public static final URLTemplate COLLABORATION_WHITELIST_EXEMPT_TARGET_ENTRIES_URL_TEMPLATE

Collaboration Whitelist Exempt Target Entries URL Template.

COLLABORATION_WHITELIST_EXEMPT_TARGET_ENTRY_URL_TEMPLATE

public static final URLTemplate COLLABORATION_WHITELIST_EXEMPT_TARGET_ENTRY_URL_TEMPLATE

Collaboration Whitelist Exempt Target Entries URL Template with given ID.

Constructor Detail

BoxCollaborationWhitelistExemptTarget

public BoxCollaborationWhitelistExemptTarget(BoxAPIConnection api,
                                             String id)

Constructs a BoxCollaborationWhitelistExemptTarget for a collaboration whitelist with a give ID.

Parameters:

api - the API connection to be used by the collaboration whitelist.

id - the ID of the collaboration whitelist.

Method Detail

create

public static BoxCollaborationWhitelistExemptTarget.Info create(BoxAPIConnection api,
                                                                String userID)

Creates a collaboration whitelist for a Box User with a given ID.

Parameters:

api - the API connection to be used by the collaboration whitelist.

userID - the ID of the Box User to add to the collaboration whitelist.

Returns:

information about the collaboration whitelist created for user.

getInfo

public BoxCollaborationWhitelistExemptTarget.Info getInfo()

Retrieves information for a collaboration whitelist for a given whitelist ID.

Returns:

information about this BoxCollaborationWhitelistExemptTarget.

getAll

public static Iterable<BoxCollaborationWhitelistExemptTarget.Info> getAll(BoxAPIConnection api,
                                                                          String... fields)

Returns all the collaboration whitelisting for user with default limit set to 100.

Parameters:

api - the API connection to be use by the resource.

fields - the fields to retrieve.

Returns:

an iterable with all the collaboration whitelists for users met search conditions.

getAll

public static Iterable<BoxCollaborationWhitelistExemptTarget.Info> getAll(BoxAPIConnection api,
                                                                          int limit,
                                                                          String... fields)

Returns all the collaboration whitelisting for user with specified filters.

Parameters:

api - the API connection to be used by the resource.

limit - the number of collaboration whitelists to retrieve.

fields - the fields to retrieve.

Returns:

an iterable with all the collaboration whitelists for users met search conditions.

delete

public void delete()

Deletes this collaboration whitelist entry for user.