Skip to content

hubcollaborations.md

Latest commit

 

History

History
160 lines (96 loc) · 4.71 KB

hubcollaborations.md

File metadata and controls

160 lines (96 loc) · 4.71 KB

HubCollaborationsManager

Get Box Hub collaborations

Retrieves all collaborations for a Box Hub.

This operation is performed by calling function getHubCollaborationsV2025R0.

See the endpoint docs at API Reference.

client.getHubCollaborations().getHubCollaborationsV2025R0(new GetHubCollaborationsV2025R0QueryParams(hub.getId()))

Arguments

  • queryParams GetHubCollaborationsV2025R0QueryParams
    • Query parameters of getHubCollaborationsV2025R0 method
  • headers GetHubCollaborationsV2025R0Headers
    • Headers of getHubCollaborationsV2025R0 method

Returns

This function returns a value of type HubCollaborationsV2025R0.

Retrieves the collaborations associated with the specified Box Hub.

Create Box Hub collaboration

Adds a collaboration for a single user or a single group to a Box Hub.

Collaborations can be created using email address, user IDs, or group IDs.

This operation is performed by calling function createHubCollaborationV2025R0.

See the endpoint docs at API Reference.

client.getHubCollaborations().createHubCollaborationV2025R0(new HubCollaborationCreateRequestV2025R0(new HubCollaborationCreateRequestV2025R0HubField(hub.getId()), new HubCollaborationCreateRequestV2025R0AccessibleByField.Builder("user").id(user.getId()).build(), "viewer"))

Arguments

  • requestBody HubCollaborationCreateRequestV2025R0
    • Request body of createHubCollaborationV2025R0 method
  • headers CreateHubCollaborationV2025R0Headers
    • Headers of createHubCollaborationV2025R0 method

Returns

This function returns a value of type HubCollaborationV2025R0.

Returns a new Box Hub collaboration object.

Get Box Hub collaboration by collaboration ID

Retrieves details for a Box Hub collaboration by collaboration ID.

This operation is performed by calling function getHubCollaborationByIdV2025R0.

See the endpoint docs at API Reference.

client.getHubCollaborations().getHubCollaborationByIdV2025R0(createdCollaboration.getId())

Arguments

  • hubCollaborationId String
    • The ID of the hub collaboration. Example: "1234"
  • headers GetHubCollaborationByIdV2025R0Headers
    • Headers of getHubCollaborationByIdV2025R0 method

Returns

This function returns a value of type HubCollaborationV2025R0.

Returns a Box Hub collaboration object.

Update Box Hub collaboration

Updates a Box Hub collaboration. Can be used to change the Box Hub role.

This operation is performed by calling function updateHubCollaborationByIdV2025R0.

See the endpoint docs at API Reference.

client.getHubCollaborations().updateHubCollaborationByIdV2025R0(createdCollaboration.getId(), new HubCollaborationUpdateRequestV2025R0.Builder().role("editor").build())

Arguments

  • hubCollaborationId String
    • The ID of the hub collaboration. Example: "1234"
  • requestBody HubCollaborationUpdateRequestV2025R0
    • Request body of updateHubCollaborationByIdV2025R0 method
  • headers UpdateHubCollaborationByIdV2025R0Headers
    • Headers of updateHubCollaborationByIdV2025R0 method

Returns

This function returns a value of type HubCollaborationV2025R0.

Returns an updated Box Hub collaboration object.

Remove Box Hub collaboration

Deletes a single Box Hub collaboration.

This operation is performed by calling function deleteHubCollaborationByIdV2025R0.

See the endpoint docs at API Reference.

client.getHubCollaborations().deleteHubCollaborationByIdV2025R0(createdCollaboration.getId())

Arguments

  • hubCollaborationId String
    • The ID of the hub collaboration. Example: "1234"
  • headers DeleteHubCollaborationByIdV2025R0Headers
    • Headers of deleteHubCollaborationByIdV2025R0 method

Returns

This function returns a value of type void.

A blank response is returned if the Box Hub collaboration was successfully deleted.