/// <summary>
/// Used to edit an existing collaboration. Descriptions of the various roles can be found
/// <see cref="https://support.box.com/entries/20366031-what-are-the-different-collaboration-permissions-and-what-access-do-they-provide"/>
/// </summary>
/// <param name="collaborationRequest"></param>
/// <returns></returns>
public async Task<BoxCollaboration> EditCollaborationAsync(BoxCollaborationRequest collaborationRequest, List<string> fields = null)
{
collaborationRequest.ThrowIfNull("collaborationRequest")
.Id.ThrowIfNullOrWhiteSpace("collaborationRequest.Id");
BoxRequest request = new BoxRequest(_config.CollaborationsEndpointUri, collaborationRequest.Id)
.Method(RequestMethod.Put)
.Param(ParamFields, fields)
.Payload(_converter.Serialize(collaborationRequest));
IBoxResponse<BoxCollaboration> response = await ToResponseAsync<BoxCollaboration>(request).ConfigureAwait(false);
return response.ResponseObject;
}
/// <summary>
/// Used to add a collaboration for a single user to a folder. Descriptions of the various roles can be found
/// <see cref="https://support.box.com/entries/20366031-what-are-the-different-collaboration-permissions-and-what-access-do-they-provide"/>
/// Either an email address or a user ID can be used to create the collaboration.
/// </summary>
/// <param name="collaborationRequest"></param>
/// <returns></returns>
public async Task<BoxCollaboration> AddCollaborationAsync(BoxCollaborationRequest collaborationRequest, List<string> fields = null)
{
collaborationRequest.ThrowIfNull("collaborationRequest")
.Item.ThrowIfNull("collaborationRequest.Item")
.Id.ThrowIfNullOrWhiteSpace("collaborationRequest.Item.Id");
collaborationRequest.AccessibleBy.ThrowIfNull("collaborationRequest.AccessibleBy");
BoxRequest request = new BoxRequest(_config.CollaborationsEndpointUri)
.Method(RequestMethod.Post)
.Param(ParamFields, fields)
.Payload(_converter.Serialize(collaborationRequest));
IBoxResponse<BoxCollaboration> response = await ToResponseAsync<BoxCollaboration>(request);
return response.ResponseObject;
}
/// <summary>
/// Used to add a collaboration for a single user or a single group to a folder.
/// Either an email address, a user ID, or a group id can be used to create the collaboration.
/// If the collaboration is being created with a group, access to this endpoint is granted based on the group's invitability_level.
/// </summary>
/// <param name="collaborationRequest">BoxCollaborationRequest object.</param>
/// <param name="fields">Attribute(s) to include in the response.</param>
/// <param name="notify">Determines if the user, (or all the users in the group) should receive email notification of the collaboration.</param>
/// <returns>The new collaboration object is returned. Errors may occur if the IDs are invalid or if the user does not have permissions to create a collaboration.</returns>
public async Task<BoxCollaboration> AddCollaborationAsync(BoxCollaborationRequest collaborationRequest, List<string> fields = null, bool? notify = null)
{
collaborationRequest.ThrowIfNull("collaborationRequest")
.Item.ThrowIfNull("collaborationRequest.Item")
.Id.ThrowIfNullOrWhiteSpace("collaborationRequest.Item.Id");
collaborationRequest.AccessibleBy.ThrowIfNull("collaborationRequest.AccessibleBy");
collaborationRequest.Role.ThrowIfNullOrWhiteSpace("Role");
BoxRequest request = new BoxRequest(_config.CollaborationsEndpointUri)
.Method(RequestMethod.Post)
.Param(ParamFields, fields)
.Payload(_converter.Serialize(collaborationRequest));
if (notify.HasValue)
{
var value = notify.Value ? "true" : "false";
request.Param("notify", value);
}
IBoxResponse<BoxCollaboration> response = await ToResponseAsync<BoxCollaboration>(request).ConfigureAwait(false);
return response.ResponseObject;
}