com.box.sdk

Class BoxCollaborationAllowlist

Object

BoxResource

BoxCollaborationAllowlist

@BoxResourceType(value="collaboration_allowlist_entry")
public class BoxCollaborationAllowlist
extends BoxResource

Represents a collaboration allowlist between a domain and a Box Enterprise. Collaboration Allowlist enables a Box Enterprise(only available if you have Box Governance) to manage a set of approved domains 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
static class	BoxCollaborationAllowlist.AllowlistDirection Enumerates the direction of the collaboration allowlist.
class	BoxCollaborationAllowlist.Info Contains information about a BoxCollaborationAllowlist.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	COLLABORATION_ALLOWLIST_ENTRIES_URL_TEMPLATE Collaboration Allowlist Entries URL Template.
static URLTemplate	COLLABORATION_ALLOWLIST_ENTRY_URL_TEMPLATE Collaboration Allowlist Entries URL Template with given ID.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static BoxCollaborationAllowlist.Info	create(BoxAPIConnection api, String domain, BoxCollaborationAllowlist.AllowlistDirection direction) Creates a new Collaboration Allowlist for a domain.
void	delete() Deletes this collaboration allowlist.
static Iterable<BoxCollaborationAllowlist.Info>	getAll(BoxAPIConnection api, int limit, String... fields) Returns all the collaboration allowlisting with specified filters.
static Iterable<BoxCollaborationAllowlist.Info>	getAll(BoxAPIConnection api, String... fields) Returns all the collaboration allowlisting with specified filters.
BoxCollaborationAllowlist.Info	getInfo()

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_ENTRIES_URL_TEMPLATE

public static final URLTemplate COLLABORATION_ALLOWLIST_ENTRIES_URL_TEMPLATE

Collaboration Allowlist Entries URL Template.

COLLABORATION_ALLOWLIST_ENTRY_URL_TEMPLATE

public static final URLTemplate COLLABORATION_ALLOWLIST_ENTRY_URL_TEMPLATE

Collaboration Allowlist Entries URL Template with given ID.

Constructor Detail

BoxCollaborationAllowlist

public BoxCollaborationAllowlist(BoxAPIConnection api,
                                 String id)

Constructs a BoxCollaborationAllowlist for a collaboration allowlist with a given 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 BoxCollaborationAllowlist.Info create(BoxAPIConnection api,
                                                    String domain,
                                                    BoxCollaborationAllowlist.AllowlistDirection direction)

Creates a new Collaboration Allowlist for a domain.

Parameters:

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

domain - the domain to be added to a collaboration allowlist for a Box Enterprise.

direction - an enum representing the direction of the collaboration allowlist. Can be set to inbound, outbound, or both.

Returns:

information about the collaboration allowlist created.

getAll

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

Returns all the collaboration allowlisting with specified filters.

Parameters:

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

fields - the fields to retrieve.

Returns:

an iterable with all the collaboration allowlists met search conditions.

getAll

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

Returns all the collaboration allowlisting with specified filters.

Parameters:

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

limit - the limit of items per single response. The default value is 100.

fields - the fields to retrieve.

Returns:

an iterable with all the collaboration allowlists met search conditions.

getInfo

public BoxCollaborationAllowlist.Info getInfo()

Returns:

information about this BoxCollaborationAllowlist.

delete

public void delete()

Deletes this collaboration allowlist.