C# Class Box.V2.Managers.BoxCollaborationsManager

Inheritance: BoxResourceManager
Show file Open project: box/box-windows-sdk-v2 Class Usage Examples

Public Methods

Method Description
AddCollaborationAsync ( BoxCollaborationRequest collaborationRequest, List fields = null, bool notify = null ) : Task

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.
BoxCollaborationsManager ( IBoxConfig config, IBoxService service, IBoxConverter converter, IAuthRepository auth, string asUser = null, bool suppressNotifications = null ) : Box.V2.Auth
EditCollaborationAsync ( BoxCollaborationRequest collaborationRequest, List fields = null ) : Task

Used to edit an existing collaboration. Descriptions of the various roles can be found here
GetCollaborationAsync ( string id, List fields = null ) : Task

Used to get information about a single collaboration.
GetPendingCollaborationAsync ( List fields = null ) : Task>

Used to retrieve all pending collaboration invites for this user (with user being determined by access token or As-User header value).
RemoveCollaborationAsync ( string id ) : Task

Used to delete a single collaboration.

Method Details

AddCollaborationAsync() public method

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.
public AddCollaborationAsync ( BoxCollaborationRequest collaborationRequest, List fields = null, bool notify = null ) : Task
collaborationRequest Box.V2.Models.BoxCollaborationRequest BoxCollaborationRequest object.
fields List Attribute(s) to include in the response.
notify bool Determines if the user, (or all the users in the group) should receive email notification of the collaboration.
return Task

BoxCollaborationsManager() public method

public BoxCollaborationsManager ( IBoxConfig config, IBoxService service, IBoxConverter converter, IAuthRepository auth, string asUser = null, bool suppressNotifications = null ) : Box.V2.Auth
config IBoxConfig
service IBoxService
converter IBoxConverter
auth IAuthRepository
asUser string
suppressNotifications bool
return Box.V2.Auth

EditCollaborationAsync() public method

Used to edit an existing collaboration. Descriptions of the various roles can be found here
public EditCollaborationAsync ( BoxCollaborationRequest collaborationRequest, List fields = null ) : Task
collaborationRequest Box.V2.Models.BoxCollaborationRequest BoxCollaborationRequest object.
fields List Attribute(s) to include in the response.
return Task

GetCollaborationAsync() public method

Used to get information about a single collaboration.
public GetCollaborationAsync ( string id, List fields = null ) : Task
id string Id of the collaboration object.
fields List Attribute(s) to include in the response.
return Task

GetPendingCollaborationAsync() public method

Used to retrieve all pending collaboration invites for this user (with user being determined by access token or As-User header value).
public GetPendingCollaborationAsync ( List fields = null ) : Task>
fields List Attribute(s) to include in the response.
return Task>

RemoveCollaborationAsync() public method

Used to delete a single collaboration.
public RemoveCollaborationAsync ( string id ) : Task
id string Id of the collaboration to delete.
return Task