JSDoc: Class: ShieldInformationBarrierSegmentsManager

new ShieldInformationBarrierSegmentsManager(client)

Parameters:

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

Source:

managers/shield-information-barrier-segments.generated.ts, line 5

Classes

ShieldInformationBarrierSegmentsManager

Methods

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

Create shield information barrier segment Creates a shield information barrier segment.

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-barrier-segments.generated.ts, line 55

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrierSegment>

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

Create shield information barrier segment Creates a shield information barrier segment.

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-barrier-segments.generated.ts, line 142

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrierSegment>

deleteById(options, callbackopt) → {Promise.<void>}

Delete shield information barrier segment Deletes the shield information barrier segment based on provided ID.

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

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

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

Source:

managers/shield-information-barrier-segments.generated.ts, line 89

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<void>

deleteById(options, callbackopt) → {Promise.<void>}

Delete shield information barrier segment Deletes the shield information barrier segment based on provided ID.

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

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

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

Source:

managers/shield-information-barrier-segments.generated.ts, line 166

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<void>

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegments>}

List shield information barrier segments Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

Name	Type	Attributes	Description
`shield_information_barrier_id`	string		The ID of the shield information barrier.
`marker`	string	<optional>	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
`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-barrier-segments.generated.ts, line 40

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrierSegments>

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegments>}

List shield information barrier segments Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

Name	Type	Attributes	Description
`shield_information_barrier_id`	string		The ID of the shield information barrier.
`marker`	string	<optional>	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
`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-barrier-segments.generated.ts, line 131

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrierSegments>

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

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

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

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

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

Source:

managers/shield-information-barrier-segments.generated.ts, line 22

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrierSegment>

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

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

Parameters:

Name Type Attributes Description

options

object

Options for the request

Properties

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

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

Source:

managers/shield-information-barrier-segments.generated.ts, line 117

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrierSegment>

update(body, options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegment>}

Update shield information barrier segment with specified ID Updates the shield information barrier segment based on provided ID..

Parameters:

Name Type Attributes Description

body object

options

object

Options for the request

Properties

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

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

Source:

managers/shield-information-barrier-segments.generated.ts, line 72

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrierSegment>

update(body, options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegment>}

Update shield information barrier segment with specified ID Updates the shield information barrier segment based on provided ID..

Parameters:

Name Type Attributes Description

body object

options

object

Options for the request

Properties

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

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

Source:

managers/shield-information-barrier-segments.generated.ts, line 154

Returns:

A promise resolving to the result or rejecting with an error

Type: Promise.<schemas.ShieldInformationBarrierSegment>