com.box.sdk

Class BoxCollaborationAllowlistExemptTarget

Object

BoxResource

BoxCollaborationAllowlistExemptTarget

@BoxResourceType(value="collaboration_allowlist_exempt_target")
public class BoxCollaborationAllowlistExemptTarget
extends BoxResource

Represents a collaboration allowlist between a user and a Box Enterprise. Collaboration Allowlist 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	BoxCollaborationAllowlistExemptTarget.Info Contains information about a BoxCollaborationAllowlistExemptTarget.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	COLLABORATION_ALLOWLIST_EXEMPT_TARGET_ENTRIES_URL_TEMPLATE Collaboration Allowlist Exempt Target Entries URL Template.
static URLTemplate	COLLABORATION_ALLOWLIST_EXEMPT_TARGET_ENTRY_URL_TEMPLATE Collaboration Allowlist Exempt Target Entries URL Template with given ID.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static BoxCollaborationAllowlistExemptTarget.Info	create(BoxAPIConnection api, String userID) Creates a collaboration allowlist for a Box User with a given ID.
void	delete() Deletes this collaboration allowlist entry for user.
static Iterable<BoxCollaborationAllowlistExemptTarget.Info>	getAll(BoxAPIConnection api, int limit, String... fields) Returns all the collaboration allowlisting for user with specified filters.
static Iterable<BoxCollaborationAllowlistExemptTarget.Info>	getAll(BoxAPIConnection api, String... fields) Returns all the collaboration allowlisting for user with default limit set to 100.
BoxCollaborationAllowlistExemptTarget.Info	getInfo() Retrieves information for a collaboration allowlist for a given allowlist 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_ALLOWLIST_EXEMPT_TARGET_ENTRIES_URL_TEMPLATE

public static final URLTemplate COLLABORATION_ALLOWLIST_EXEMPT_TARGET_ENTRIES_URL_TEMPLATE

Collaboration Allowlist Exempt Target Entries URL Template.

COLLABORATION_ALLOWLIST_EXEMPT_TARGET_ENTRY_URL_TEMPLATE

public static final URLTemplate COLLABORATION_ALLOWLIST_EXEMPT_TARGET_ENTRY_URL_TEMPLATE

Collaboration Allowlist Exempt Target Entries URL Template with given ID.

Constructor Detail

BoxCollaborationAllowlistExemptTarget

public BoxCollaborationAllowlistExemptTarget(BoxAPIConnection api,
                                             String id)

Constructs a BoxCollaborationAllowlistExemptTarget for a collaboration allowlist with a give ID.

Parameters:

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

id - the ID of the collaboration allowlist.

Method Detail

create

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

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

Parameters:

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

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

Returns:

information about the collaboration allowlist created for user.

getAll

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

Returns all the collaboration allowlisting 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 allowlists for users met search conditions.

getAll

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

Returns all the collaboration allowlisting for user with specified filters.

Parameters:

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

limit - the number of collaboration allowlists to retrieve.

fields - the fields to retrieve.

Returns:

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

getInfo

public BoxCollaborationAllowlistExemptTarget.Info getInfo()

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

Returns:

information about this BoxCollaborationAllowlistExemptTarget.

delete

public void delete()

Deletes this collaboration allowlist entry for user.