public class SharedLinksFilesManager extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
SharedLinksFilesManager.Builder |
| Modifier and Type | Field and Description |
|---|---|
Authentication |
auth |
NetworkSession |
networkSession |
| Modifier | Constructor and Description |
|---|---|
|
SharedLinksFilesManager() |
protected |
SharedLinksFilesManager(SharedLinksFilesManager.Builder builder) |
public Authentication auth
public NetworkSession networkSession
public SharedLinksFilesManager()
protected SharedLinksFilesManager(SharedLinksFilesManager.Builder builder)
public FileFull findFileForSharedLink(FindFileForSharedLinkHeaders headers)
A shared file can be represented by a shared link, which can originate within the current enterprise or within another.
This endpoint allows an application to retrieve information about a shared file when only given a shared link.
The `shared_link_permission_options` array field can be returned by requesting it in the `fields` query parameter.
headers - Headers of findFileForSharedLink methodpublic FileFull findFileForSharedLink(FindFileForSharedLinkQueryParams queryParams, FindFileForSharedLinkHeaders headers)
A shared file can be represented by a shared link, which can originate within the current enterprise or within another.
This endpoint allows an application to retrieve information about a shared file when only given a shared link.
The `shared_link_permission_options` array field can be returned by requesting it in the `fields` query parameter.
queryParams - Query parameters of findFileForSharedLink methodheaders - Headers of findFileForSharedLink methodpublic FileFull getSharedLinkForFile(String fileId, GetSharedLinkForFileQueryParams queryParams)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of getSharedLinkForFile methodpublic FileFull getSharedLinkForFile(String fileId, GetSharedLinkForFileQueryParams queryParams, GetSharedLinkForFileHeaders headers)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of getSharedLinkForFile methodheaders - Headers of getSharedLinkForFile methodpublic FileFull addShareLinkToFile(String fileId, AddShareLinkToFileQueryParams queryParams)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of addShareLinkToFile methodpublic FileFull addShareLinkToFile(String fileId, AddShareLinkToFileRequestBody requestBody, AddShareLinkToFileQueryParams queryParams)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
requestBody - Request body of addShareLinkToFile methodqueryParams - Query parameters of addShareLinkToFile methodpublic FileFull addShareLinkToFile(String fileId, AddShareLinkToFileQueryParams queryParams, AddShareLinkToFileHeaders headers)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of addShareLinkToFile methodheaders - Headers of addShareLinkToFile methodpublic FileFull addShareLinkToFile(String fileId, AddShareLinkToFileRequestBody requestBody, AddShareLinkToFileQueryParams queryParams, AddShareLinkToFileHeaders headers)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
requestBody - Request body of addShareLinkToFile methodqueryParams - Query parameters of addShareLinkToFile methodheaders - Headers of addShareLinkToFile methodpublic FileFull updateSharedLinkOnFile(String fileId, UpdateSharedLinkOnFileQueryParams queryParams)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of updateSharedLinkOnFile methodpublic FileFull updateSharedLinkOnFile(String fileId, UpdateSharedLinkOnFileRequestBody requestBody, UpdateSharedLinkOnFileQueryParams queryParams)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
requestBody - Request body of updateSharedLinkOnFile methodqueryParams - Query parameters of updateSharedLinkOnFile methodpublic FileFull updateSharedLinkOnFile(String fileId, UpdateSharedLinkOnFileQueryParams queryParams, UpdateSharedLinkOnFileHeaders headers)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of updateSharedLinkOnFile methodheaders - Headers of updateSharedLinkOnFile methodpublic FileFull updateSharedLinkOnFile(String fileId, UpdateSharedLinkOnFileRequestBody requestBody, UpdateSharedLinkOnFileQueryParams queryParams, UpdateSharedLinkOnFileHeaders headers)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
requestBody - Request body of updateSharedLinkOnFile methodqueryParams - Query parameters of updateSharedLinkOnFile methodheaders - Headers of updateSharedLinkOnFile methodpublic FileFull removeSharedLinkFromFile(String fileId, RemoveSharedLinkFromFileQueryParams queryParams)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of removeSharedLinkFromFile methodpublic FileFull removeSharedLinkFromFile(String fileId, RemoveSharedLinkFromFileRequestBody requestBody, RemoveSharedLinkFromFileQueryParams queryParams)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
requestBody - Request body of removeSharedLinkFromFile methodqueryParams - Query parameters of removeSharedLinkFromFile methodpublic FileFull removeSharedLinkFromFile(String fileId, RemoveSharedLinkFromFileQueryParams queryParams, RemoveSharedLinkFromFileHeaders headers)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of removeSharedLinkFromFile methodheaders - Headers of removeSharedLinkFromFile methodpublic FileFull removeSharedLinkFromFile(String fileId, RemoveSharedLinkFromFileRequestBody requestBody, RemoveSharedLinkFromFileQueryParams queryParams, RemoveSharedLinkFromFileHeaders headers)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
requestBody - Request body of removeSharedLinkFromFile methodqueryParams - Query parameters of removeSharedLinkFromFile methodheaders - Headers of removeSharedLinkFromFile methodpublic Authentication getAuth()
public NetworkSession getNetworkSession()