Class: ShieldInformationBarrierReportsManager

ShieldInformationBarrierReportsManager(client)

new ShieldInformationBarrierReportsManager(client)

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

Classes

ShieldInformationBarrierReportsManager

Methods

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

Create shield information barrier report Creates a shield information barrier report for a given barrier.
Parameters:
Name Type Attributes Description
body schemas.ShieldInformationBarrierReference
options object <optional>
 Options for the request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.ShieldInformationBarrierReport>

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

Create shield information barrier report Creates a shield information barrier report for a given barrier.
Parameters:
Name Type Attributes Description
body schemas.ShieldInformationBarrierReference
options object <optional>
 Options for the request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.ShieldInformationBarrierReport>

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

List shield information barrier reports Lists shield information barrier reports.
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:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.ShieldInformationBarrierReports>

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

List shield information barrier reports Lists shield information barrier reports.
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:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.ShieldInformationBarrierReports>

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

Get shield information barrier report by ID Retrieves a shield information barrier report by its ID.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Description
shield_information_barrier_report_id string The ID of the shield information barrier Report.
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.ShieldInformationBarrierReport>

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

Get shield information barrier report by ID Retrieves a shield information barrier report by its ID.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Description
shield_information_barrier_report_id string The ID of the shield information barrier Report.
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.ShieldInformationBarrierReport>