JSDoc: Class: ShieldInformationBarrierManager

new ShieldInformationBarrierManager(client)

Parameters:

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

Source:

managers/shield-information-barriers.generated.ts, line 5

Classes

ShieldInformationBarrierManager

Methods

changeStatusById(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

Add changed status of shield information barrier with specified ID Change status of shield information barrier with the specified ID.

Parameters:

Name	Type	Attributes	Description
`body`	object
`options`	object	<optional>	Options for the request
`callback`	function	<optional>	Passed the result if successful, error otherwise

Source:

managers/shield-information-barriers.generated.ts, line 72

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrier>

changeStatusById(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

Add changed status of shield information barrier with specified ID Change status of shield information barrier with the specified ID.

Parameters:

Name	Type	Attributes	Description
`body`	object
`options`	object	<optional>	Options for the request
`callback`	function	<optional>	Passed the result if successful, error otherwise

Source:

managers/shield-information-barriers.generated.ts, line 138

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrier>

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

Create shield information barrier Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.

Parameters:

Name	Type	Attributes	Description
`body`	object
`options`	object	<optional>	Options for the request
`callback`	function	<optional>	Passed the result if successful, error otherwise

Source:

managers/shield-information-barriers.generated.ts, line 56

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrier>

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

Create shield information barrier Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.

Parameters:

Name	Type	Attributes	Description
`body`	object
`options`	object	<optional>	Options for the request
`callback`	function	<optional>	Passed the result if successful, error otherwise

Source:

managers/shield-information-barriers.generated.ts, line 127

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrier>

getAll(optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarriers>}

List shield information barriers Retrieves a list of shield information barrier objects for the enterprise of JWT.

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

Name	Type	Attributes	Description
`marker`	string	<optional>	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
`limit`	number	<optional>	The maximum number of items to return per page.

callback function <optional> Passed the result if successful, error otherwise

Source:

managers/shield-information-barriers.generated.ts, line 39

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarriers>

getAll(optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarriers>}

List shield information barriers Retrieves a list of shield information barrier objects for the enterprise of JWT.

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

Name	Type	Attributes	Description
`marker`	string	<optional>	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
`limit`	number	<optional>	The maximum number of items to return per page.

callback function <optional> Passed the result if successful, error otherwise

Source:

managers/shield-information-barriers.generated.ts, line 114

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarriers>

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

Get shield information barrier with specified ID Get shield information barrier based on provided ID.

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

Name	Type	Description
`shield_information_barrier_id`	string	The ID of the shield information barrier.

callback function <optional> Passed the result if successful, error otherwise

Source:

managers/shield-information-barriers.generated.ts, line 22

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrier>

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

Get shield information barrier with specified ID Get shield information barrier based on provided ID.

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

Name	Type	Description
`shield_information_barrier_id`	string	The ID of the shield information barrier.

callback function <optional> Passed the result if successful, error otherwise

Source:

managers/shield-information-barriers.generated.ts, line 101

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrier>