UserCollaborationsManager

• Get collaboration
• Update collaboration
• Remove collaboration
• Create collaboration

Get collaboration

Retrieves a single collaboration.

This operation is performed by calling function getCollaborationById.

See the endpoint docs at API Reference.

try await client.userCollaborations.getCollaborationById(collaborationId: collaborationId)

Arguments

• collaborationId String
  • The ID of the collaboration. Example: "1234"
• queryParams GetCollaborationByIdQueryParams
  • Query parameters of getCollaborationById method
• headers GetCollaborationByIdHeaders
  • Headers of getCollaborationById method

Returns

This function returns a value of type Collaboration.

Returns a collaboration object.

Update collaboration

Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. In case of accepting collaboration invite, role is not required.

This operation is performed by calling function updateCollaborationById.

See the endpoint docs at API Reference.

try await client.userCollaborations.updateCollaborationById(collaborationId: collaborationId, requestBody: UpdateCollaborationByIdRequestBody(role: UpdateCollaborationByIdRequestBodyRoleField.viewer))

Arguments

• collaborationId String
  • The ID of the collaboration. Example: "1234"
• requestBody UpdateCollaborationByIdRequestBody
  • Request body of updateCollaborationById method
• headers UpdateCollaborationByIdHeaders
  • Headers of updateCollaborationById method

Returns

This function returns a value of type Collaboration?.

Returns an updated collaboration object unless the owner has changed.If the role is changed to owner, the collaboration is deleted and a new collaboration is created. The previous owner of the old collaboration will be a co-owner on the new collaboration.

Remove collaboration

Deletes a single collaboration.

This operation is performed by calling function deleteCollaborationById.

See the endpoint docs at API Reference.

try await client.userCollaborations.deleteCollaborationById(collaborationId: collaborationId)

Arguments

• collaborationId String
  • The ID of the collaboration. Example: "1234"
• headers DeleteCollaborationByIdHeaders
  • Headers of deleteCollaborationById method

Returns

This function returns a value of type ``.

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

Create collaboration

Adds a collaboration for a single user or a single group to a file or folder.

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

If a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited.

If collaboration is in pending status, field name is redacted when:

• a collaboration was created using user_id,
• a collaboration was created using login.

This operation is performed by calling function createCollaboration.

See the endpoint docs at API Reference.

try await client.userCollaborations.createCollaboration(requestBody: CreateCollaborationRequestBody(item: CreateCollaborationRequestBodyItemField(type: CreateCollaborationRequestBodyItemTypeField.folder, id: folder.id), accessibleBy: CreateCollaborationRequestBodyAccessibleByField(type: CreateCollaborationRequestBodyAccessibleByTypeField.user, id: user.id), role: CreateCollaborationRequestBodyRoleField.editor))

Arguments

• requestBody CreateCollaborationRequestBody
  • Request body of createCollaboration method
• queryParams CreateCollaborationQueryParams
  • Query parameters of createCollaboration method
• headers CreateCollaborationHeaders
  • Headers of createCollaboration method

Returns

This function returns a value of type Collaboration.

Returns a new collaboration object.