Class: ShieldInformationBarrierSegmentMembersManager

ShieldInformationBarrierSegmentMembersManager(client)

new ShieldInformationBarrierSegmentMembersManager(client)

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

Classes

ShieldInformationBarrierSegmentMembersManager

Methods

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

Create shield information barrier segment member Creates a new shield information barrier segment member.
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:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.ShieldInformationBarrierSegmentMember>

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

Create shield information barrier segment member Creates a new shield information barrier segment member.
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:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<schemas.ShieldInformationBarrierSegmentMember>

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

Delete shield information barrier segment member by ID Deletes a shield information barrier segment member based on provided ID.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Description
shield_information_barrier_segment_member_id string The ID of the shield information barrier segment Member.
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.<void>

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

Delete shield information barrier segment member by ID Deletes a shield information barrier segment member based on provided ID.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Description
shield_information_barrier_segment_member_id string The ID of the shield information barrier segment Member.
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.<void>

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

List shield information barrier segment members Lists shield information barrier segment members based on provided segment IDs.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Attributes Description
shield_information_barrier_segment_id string The ID of the shield information barrier segment.
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.ShieldInformationBarrierSegmentMembers>

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

List shield information barrier segment members Lists shield information barrier segment members based on provided segment IDs.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Attributes Description
shield_information_barrier_segment_id string The ID of the shield information barrier segment.
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.ShieldInformationBarrierSegmentMembers>

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

Get shield information barrier segment member by ID Retrieves a shield information barrier segment member by its ID.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Description
shield_information_barrier_segment_member_id string The ID of the shield information barrier segment Member.
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.ShieldInformationBarrierSegmentMember>

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

Get shield information barrier segment member by ID Retrieves a shield information barrier segment member by its ID.
Parameters:
Name Type Attributes Description
options object Options for the request
Properties
Name Type Description
shield_information_barrier_segment_member_id string The ID of the shield information barrier segment Member.
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.ShieldInformationBarrierSegmentMember>