Skip to content

documentation for single file collab #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 2, 2018
Merged

documentation for single file collab #547

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e0d9d1
documentation for single file collab
Feb 2, 2018
b862ee1
fixed broken javadocs links
Feb 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions doc/files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ file's contents, upload new versions, and perform other common file operations
* [Lock a File](#lock-a-file)
* [Unlock a File](#unlock-a-file)
* [Create a Shared Link](#create-a-shared-link)
* [Share a File](#share-a-file)
* [Get an Embed Link](#get-an-embed-link)
* [Get Thumbnail](#get-thumbnail)
* [Create Metadata](#create-metadata)
Expand Down Expand Up @@ -505,6 +506,32 @@ BoxSharedLink sharedLink = file.createSharedLink(BoxSharedLink.Access.OPEN, unsh

[create-shared-link]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#createSharedLink-com.box.sdk.BoxSharedLink.Access-java.util.Date-com.box.sdk.BoxSharedLink.Permissions-

Share a File
------------
You can invite another person to collaborate on a file by email with [`collaborate(String, BoxCollaboration.Role, Boolean, Boolean)`][share-a-file].

The notify param will determine if the user or group will receive email notifications.

The can_view_path param allows the invitee to see the entire ancestral path of the associated file. The user will not gain privileges in any ancestral file.

```java
BoxFile file = new BoxFile(api, "id");
BoxCollaboration.Info collabInfo = file.collaborate("testuser@example.com", BoxCollaboration.Role.EDITOR, true, true);
```

Alternatively, if you know the user's ID, you can invite them directly without needing to know their email address with the
[`collaborate(BoxCollaborator, BoxCollaboration.Role, Boolean, Boolean)`][share-a-file-userID]

```java
BoxUser collaborator = new User(api, "user-id");
BoxFile file = new BoxFile(api, "file-id");
BoxCollaboration.Info collabInfo = file.collaborate(collaborator, BoxCollaboration.Role.EDITOR, true, true);
```

[share-a-file]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#collaborate-java.lang.String-com.box.sdk.BoxCollaboration.Role-java.lang.Boolean-java.lang.Boolean-
[share-a-file-userID]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#collaborate-com.box.sdk.BoxCollaborator-com.box.sdk.BoxCollaboration.Role-java.lang.Boolean-java.lang.Boolean-


Get an Embed Link
-----------------

Expand Down