JSDoc: Class: CollaborationAllowlist

Constructor

new CollaborationAllowlist(client) → {void}

Parameters:

Name	Type	Description
`client`	BoxClient	The Box API Client that is responsible for making calls to the API

Source:

managers/collaboration-allowlist.ts, line 30

Returns:

Type: void

Members

(readonly) directions :CollaborationAllowlistDirection

Enum of valid collaboration allowlist directions

Type:

CollaborationAllowlistDirection

Source:

managers/collaboration-allowlist.ts, line 188

Methods

addDomain(domain, direction, callbackopt) → {Promise.<Object>}

Add a domain to the enterprise's allowlist. API Endpoint: '/collaboration_whitelist_entries' Method: POST

Parameters:

Name	Type	Attributes	Description
`domain`	string		The domain to be added to the allowlist
`direction`	CollaborationAllowlistDirection		Inbound refers to collaboration actions within an enterprise. Outbound refers to collaboration actions external to an enterprise. Both refers to collaboration actions taken within and external to an enterprise
`callback`	function	<optional>	Passed the collaboration allowlist information if it was created successfully

Source:

managers/collaboration-allowlist.ts, line 49

Returns:

A promise resolve to the collaboration allowlist object

Type: Promise.<Object>

addDomain(domain, direction, callbackopt) → {Promise.<Object>}

Add a domain to the enterprise's allowlist. API Endpoint: '/collaboration_whitelist_entries' Method: POST

Parameters:

Name	Type	Attributes	Description
`domain`	string		The domain to be added to the allowlist
`direction`	CollaborationAllowlistDirection		Inbound refers to collaboration actions within an enterprise. Outbound refers to collaboration actions external to an enterprise. Both refers to collaboration actions taken within and external to an enterprise
`callback`	function	<optional>	Passed the collaboration allowlist information if it was created successfully

Source:

managers/collaboration-allowlist.ts, line 209

Returns:

A promise resolve to the collaboration allowlist object

Type: Promise.<Object>

addExemption(userID, callbackopt) → {Promise.<Object>}

Adds a Box User to the exempt target list. API Endpoint: '/collaboration_whitelist_exempt_targets' Method: GET

Parameters:

Name	Type	Attributes	Description
`userID`	string		The ID of the Box User to be added to the allowlist
`callback`	function	<optional>	Passed a collaboration allowlist for user if successful, error otherwise

Source:

managers/collaboration-allowlist.ts, line 118

Returns:

A promise resolving to a user collaboration allowlist

Type: Promise.<Object>

addExemption(userID, callbackopt) → {Promise.<Object>}

Adds a Box User to the exempt target list. API Endpoint: '/collaboration_whitelist_exempt_targets' Method: GET

Parameters:

Name	Type	Attributes	Description
`userID`	string		The ID of the Box User to be added to the allowlist
`callback`	function	<optional>	Passed a collaboration allowlist for user if successful, error otherwise

Source:

managers/collaboration-allowlist.ts, line 260

Returns:

A promise resolving to a user collaboration allowlist

Type: Promise.<Object>

getAllAllowlistedDomains(optionsopt, callbackopt) → {Promise.<Object>}

Requests all collaboration allowlist entries within an enterprise. API Endpoint: '/collaboration_whitelist_entries' Method: GET

Parameters:

Name Type Attributes Description

options

Object

Additional options. Can be left null in most cases.

Properties

Name	Type	Attributes	Description
`limit`	int	<optional>	The number of collaboration allowlists to retrieve
`marker`	string	<optional>	Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.

callback function <optional> Passed a list of collaboration allowlists if successful, error otherwise

Source:

managers/collaboration-allowlist.ts, line 87

Returns:

A promise resolving to the collection of collaboration allowlists

Type: Promise.<Object>

getAllAllowlistedDomains(optionsopt, callbackopt) → {Promise.<Object>}

Requests all collaboration allowlist entries within an enterprise. API Endpoint: '/collaboration_whitelist_entries' Method: GET

Parameters:

Name Type Attributes Description

options

Object

Additional options. Can be left null in most cases.

Properties

Name	Type	Attributes	Description
`limit`	int	<optional>	The number of collaboration allowlists to retrieve
`marker`	string	<optional>	Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.

callback function <optional> Passed a list of collaboration allowlists if successful, error otherwise

Source:

managers/collaboration-allowlist.ts, line 236

Returns:

A promise resolving to the collection of collaboration allowlists

Type: Promise.<Object>

getAllExemptions(optionsopt, callbackopt) → {Promise.<Object>}

Retrieve a list of all exemptions to an enterprise's collaboration allowlist. API Endpoint: '/collaboration_whitelist_exempt_targets' Method: GET

Parameters:

Name Type Attributes Description

options

Object

Additional options. Can be left null in most cases.

Properties

Name	Type	Attributes	Description
`limit`	int	<optional>	The number of user collaboration allowlists to retrieve
`marker`	string	<optional>	Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.

callback function <optional> Passed a list of user collaboration allowlists if successful, error otherwise

Source:

managers/collaboration-allowlist.ts, line 160

Returns:

A promise resolving to the collection of user collaboration allowlists

Type: Promise.<Object>

getAllExemptions(optionsopt, callbackopt) → {Promise.<Object>}

Retrieve a list of all exemptions to an enterprise's collaboration allowlist. API Endpoint: '/collaboration_whitelist_exempt_targets' Method: GET

Parameters:

Name Type Attributes Description

options

Object

Additional options. Can be left null in most cases.

Properties

Name	Type	Attributes	Description
`limit`	int	<optional>	The number of user collaboration allowlists to retrieve
`marker`	string	<optional>	Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.

callback function <optional> Passed a list of user collaboration allowlists if successful, error otherwise

Source:

managers/collaboration-allowlist.ts, line 287

Returns:

A promise resolving to the collection of user collaboration allowlists

Type: Promise.<Object>

getAllowlistedDomain(domainID, optionsopt, callbackopt) → {Promise.<Object>}

Requests a collaboration allowlist entry with a given ID. API Endpoint: '/collaboration_whitelist_entries/:domainID' Method: GET

Parameters:

Name	Type	Attributes	Description
`domainID`	string		Box ID of the collaboration allowlist being requested
`options`	Object	<optional>	Additional options for the request. Can be left null in most cases.
`callback`	function	<optional>	Passed the collaboration allowlist information if it was acquired successfully

Source:

managers/collaboration-allowlist.ts, line 70

Returns:

A promise resolving to the collaboration allowlist object

Type: Promise.<Object>

getAllowlistedDomain(domainID, optionsopt, callbackopt) → {Promise.<Object>}

Requests a collaboration allowlist entry with a given ID. API Endpoint: '/collaboration_whitelist_entries/:domainID' Method: GET

Parameters:

Name	Type	Attributes	Description
`domainID`	string		Box ID of the collaboration allowlist being requested
`options`	Object	<optional>	Additional options for the request. Can be left null in most cases.
`callback`	function	<optional>	Passed the collaboration allowlist information if it was acquired successfully

Source:

managers/collaboration-allowlist.ts, line 222

Returns:

A promise resolving to the collaboration allowlist object

Type: Promise.<Object>

getExemption(exemptionID, optionsopt, callbackopt) → {Promise.<Object>}

Retrieves information about a collaboration allowlist for user by allowlist ID. API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID' Method: GET

Parameters:

Name	Type	Attributes	Description
`exemptionID`	string		The ID of the collaboration allowlist
`options`	Object	<optional>	Additional options for the request. Can be left null in most cases.
`callback`	function	<optional>	Passed the collaboration allowlist information for a user if it was acquired successfully

Source:

managers/collaboration-allowlist.ts, line 141

Returns:

A promise resolving to the collaboration allowlist object

Type: Promise.<Object>

getExemption(exemptionID, optionsopt, callbackopt) → {Promise.<Object>}

Retrieves information about a collaboration allowlist for user by allowlist ID. API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID' Method: GET

Parameters:

Name	Type	Attributes	Description
`exemptionID`	string		The ID of the collaboration allowlist
`options`	Object	<optional>	Additional options for the request. Can be left null in most cases.
`callback`	function	<optional>	Passed the collaboration allowlist information for a user if it was acquired successfully

Source:

managers/collaboration-allowlist.ts, line 273

Returns:

A promise resolving to the collaboration allowlist object

Type: Promise.<Object>

removeDomain(domainID, callbackopt) → {Promise.<void>}

Delete a given collaboration allowlist entry. API Endpoint: '/collaboration_whitelist_entries/:domainID' Method: DELETE

Parameters:

Name	Type	Attributes	Description
`domainID`	string		Box ID of the collaboration allowlist being requested
`callback`	function	<optional>	Empty response body passed if successful.

Source:

managers/collaboration-allowlist.ts, line 104

Returns:

A promise resolving to nothing

Type: Promise.<void>

removeDomain(domainID, callbackopt) → {Promise.<void>}

Delete a given collaboration allowlist entry. API Endpoint: '/collaboration_whitelist_entries/:domainID' Method: DELETE

Parameters:

Name	Type	Attributes	Description
`domainID`	string		Box ID of the collaboration allowlist being requested
`callback`	function	<optional>	Empty response body passed if successful.

Source:

managers/collaboration-allowlist.ts, line 248

Returns:

A promise resolving to nothing

Type: Promise.<void>

removeExemption(exemptionID, callbackopt) → {Promise.<void>}

Delete a given user collaboration allowlist. API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID' Method: DELETE

Parameters:

Name	Type	Attributes	Description
`exemptionID`	string		Box ID of the user collaboration allowlist being requested
`callback`	function	<optional>	Empty response body passed if successful.

Source:

managers/collaboration-allowlist.ts, line 177

Returns:

A promise resolving to nothing

Type: Promise.<void>

removeExemption(exemptionID, callbackopt) → {Promise.<void>}

Delete a given user collaboration allowlist. API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID' Method: DELETE

Parameters:

Name	Type	Attributes	Description
`exemptionID`	string		Box ID of the user collaboration allowlist being requested
`callback`	function	<optional>	Empty response body passed if successful.

Source:

managers/collaboration-allowlist.ts, line 299

Returns:

A promise resolving to nothing

Type: Promise.<void>