Skip to content

Fix more documentation issues #529

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
Jan 25, 2018
Merged

Fix more documentation issues #529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a2e91b
Fix more documentation issues
Jan 24, 2018
6317748
Merge branch 'master' into more_docs_fixes
Jan 25, 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
2 changes: 1 addition & 1 deletion doc/files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,7 @@ Date expiresAt = new Date();
file.lock(expiresAt);
```

[lock]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#lock-java.lang.Date-
[lock]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#lock-java.util.Date-

Unlock a File
-------------
Expand Down
2 changes: 1 addition & 1 deletion doc/legal_holds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ info.addPendingChange("description", "new description");
policy.updateInfo(info);
```

[update-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxLegalHoldPolicy.html#update-com.box.sdk.BoxLegalHoldPolicy.Info-
[update-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxLegalHoldPolicy.html#updateInfo-com.box.sdk.BoxLegalHoldPolicy.Info-

Delete Legal Hold Policy
------------------------
Expand Down
12 changes: 6 additions & 6 deletions doc/metadata_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Metadata metadata = new Metadata(jsonObject);
boxFile.createMetadata("CustomField", metadata);
```

[create-metadata-template]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#createMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-java.lang.Boolean-java.lang.List-
[create-metadata-template]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#createMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-java.lang.String-boolean-java.util.List-

Update Metadata Template
------------------------
Expand Down Expand Up @@ -68,9 +68,9 @@ Also [`getMetadataTemplate(BoxAPIConnection, String)`][get-metadata-template-2]
MetadataTemplate template = MetadataTemplate.getMetadataTemplate(api, "templateName");
```

[get-metadata-template-1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getEnterpriseMetadataTemplates-com.box.sdk.BoxAPIConnection-
[get-metadata-template-2]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getEnterpriseMetadataTemplates-com.box.sdk.BoxAPIConnection-java.lang.String-
[get-metadata-template-3]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getEnterpriseMetadataTemplates-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-java.lang.String...-
[get-metadata-template-1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getMetadataTemplate-com.box.sdk.BoxAPIConnection-
[get-metadata-template-2]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String-
[get-metadata-template-3]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-java.lang.String...-


Get Enterprise Metadata Templates
Expand All @@ -94,11 +94,11 @@ for (MetadataTemplate templateInfo : templates) {
Delete a Metadata Template
--------------------------

The ['deleteMetadataTemplate(BoxAPIConnection, String scope, String template)'][delete-metadata-template] method will remove a metadata template schema
The [`deleteMetadataTemplate(BoxAPIConnection, String scope, String template)`][delete-metadata-template] method will remove a metadata template schema
from an enterprise.

```java
MetadataTemplate.deleteMetadataTemplate(api, "enterprise", "templateName");
```

[delete-metadata-template]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getEnterpriseMetadataTemplates-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-
[delete-metadata-template]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#deleteMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-
12 changes: 6 additions & 6 deletions doc/retention_policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ for (BoxRetentionPolicy.Info policyInfo : policies) {
Get Retention Policy Assignments
--------------

Calling [`getAllAssignments(String...)`][get-all-assignments] will return an iterable that will page through all of the assignments of the retention policy. It is possible to specify maximum number of items per single response and fields to retrieve by calling [`getFolderAssignments(int, String...)`][get-all-assignments-with-params].
Calling [`getAllAssignments(String...)`][get-all-assignments] will return an iterable that will page through all of the assignments of the retention policy. It is possible to specify maximum number of items per single response and fields to retrieve by calling [`getAllAssignments(int, String...)`][get-all-assignments-with-params].
If it is necessary to retrieve only assignments of certain type, you can call [`getFolderAssignments(int, String...)`][get-folder-assignments] or [`getEnterpriseAssignments(int, String...)`][get-enterprise-assignments].

```java
Expand All @@ -100,7 +100,7 @@ for (BoxRetentionPolicyAssignments.Info assignmentInfo : enterpriseAssignments)
[get-all-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getAllAssignments-java.lang.String...-
[get-all-assignments-with-params]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getAllAssignments-int-java.lang.String...-
[get-folder-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getFolderAssignments-int-java.lang.String...-
[get-enterprise-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getEnterpiseAssignments-int-java.lang.String...-
[get-enterprise-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getEnterpriseAssignments-int-java.lang.String...-

Create Retention Policy Assignment
--------------
Expand Down Expand Up @@ -143,7 +143,7 @@ BoxFileVersionRetention.Info policyInfo = policy.getInfo();
Get File Version Retentions
--------------

To get an iterable with all file version retentions for current retention policy, call the static [`getAll(BoxAPIConnection, String...)`][get-all-file-version-retentions]. It is possible to add filters to query using [`QueryFilter`][query-filter] object as a parameter: [`getAll(BoxAPIConnection, QueryFilter, String...)`][get-all-file-version-retentions-with-filter].
To get an iterable with all file version retentions for current retention policy, call the static [`getAll(BoxAPIConnection, String...)`][get-all-file-version-retentions]. It is possible to add filters to query using [`QueryFilter`][query-filter] object as a parameter: [`getRetentions(BoxAPIConnection, QueryFilter, String...)`][get-all-file-version-retentions-with-filter].

```java
BoxFileVersionRetention.QueryFilter filter = new BoxFileVersionRetention.QueryFilter()
Expand All @@ -160,6 +160,6 @@ for (BoxFileVersionRetention.Info retentionInfo : retentions) {
}
```

[get-all-file-version-retentions]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#getInfo-com.box.sdk.BoxAPIConnection-java.lang.String...-
[query-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#QueryFilter
[get-all-file-version-retentions-with-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#getInfo-com.box.sdk.BoxAPIConnection-com.box.sdk.BoxFileVersionRetention.QueryFilter-java.lang.String...-
[get-all-file-version-retentions]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#getAll-com.box.sdk.BoxAPIConnection-java.lang.String...-
[query-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.QueryFilter.html
[get-all-file-version-retentions-with-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#getRetentions-com.box.sdk.BoxAPIConnection-com.box.sdk.BoxFileVersionRetention.QueryFilter-java.lang.String...-
2 changes: 1 addition & 1 deletion doc/tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,4 @@ BoxTaskAssignment.Info info = taskAssignment.getInfo();
taskAssignment.updateInfo(info);
```

[update-assignment]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxTaskAssignment.html#updateInfo-com.box.sdk.BoxTask.Info-
[update-assignment]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxTaskAssignment.html#updateInfo-com.box.sdk.BoxTaskAssignment.Info-
6 changes: 3 additions & 3 deletions doc/terms_of_service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ If they have then you will need to make the update call.
Accept or decline a Terms of Service for existing user
------------------------------------------------------

For an existing user you can accept or decline a terms of service by calling [`updateInfo(BoxTermsOfService.Info)``][update-user-status]
For an existing user you can accept or decline a terms of service by calling [`updateInfo(BoxTermsOfService.Info)`][update-user-status]

```java
BoxTermsOfServiceUserStatus tosUserStatus = new BoxTermsOfServiceUserStatus(api, "tos-user-status-id");
Expand All @@ -107,7 +107,7 @@ tosUserStatus.updateInfo(tosUSerStatusInfo);
Get User Status on a Terms of service
-------------------------------------

You can retrieve the terms of service status for a user by calling[`getInfo(BoxApiConnection, String, String)``][get-user-status1]
You can retrieve the terms of service status for a user by calling[`getInfo(BoxApiConnection, String, String)`][get-user-status1]

```java
List<BoxTermsOfServiceUserStatus.Info> tosUserStatusInfo = BoxTermsOfServiceUserStatus.getInfo(api, "tos-id", "user-id");
Expand All @@ -116,7 +116,7 @@ for(BoxTermsOfServiceUserStatus.Info info : toUserStatusInfo){
}
```

Alternatively you can get the user status by the ID of the terms of service by calling[`getInfo(BoxApiConnection, String)``][get-user-status2]
Alternatively you can get the user status by the ID of the terms of service by calling[`getInfo(BoxApiConnection, String)`][get-user-status2]

```java
List<BoxTermsOfServiceUserStatus.Info> tosUserStatusInfo = BoxTermsOfServiceUserStatus.getInfo(api, "tos-id");
Expand Down
7 changes: 3 additions & 4 deletions doc/users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,16 @@ Users represent an individual's account on Box.
Get the Current User's Information
----------------------------------

To get the current user, call the static [`getCurrentUser(BoxAPIConnection)`]
[get-current-user] method. Then use [`getInfo()`][get-info] to get information
about the user.
To get the current user, call the static [`getCurrentUser(BoxAPIConnection)`][get-current-user] method.
Then use [`getInfo(String...)`][get-info] to get information about the user.

```java
BoxUser user = BoxUser.getCurrentUser(api);
BoxUser.Info info = user.getInfo();
```

[get-current-user]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxUser.html#getCurrentUser-com.box.sdk.BoxAPIConnection-
[get-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxUser.html#getInfo--
[get-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxUser.html#getInfo-java.lang.String...-

Create An Enterprise User
-------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/webhooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ info.addPendingChange("address", url);
webhook.update(info);
```

[update]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxWebHook.html#update-com.box.sdk.BoxWebHook.Info-
[update]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxWebHook.html#updateInfo-com.box.sdk.BoxWebHook.Info-