FileRequests

This defines the HTTP requests in the connect API for files functionality.

Author

sfell

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
open fun addFileShare(fileId: String, entityId: String, shareType: String): RestRequest
Build a request that will add a file share for the specified fileId to the specified entityId.
Link copied to clipboard
Build a request that can fetch the latest file details of one or more files in a single request.
Link copied to clipboard
open fun deleteFileShare(shareId: String): RestRequest
Build a request that will delete the specified file share.
Link copied to clipboard
open fun fileContents(sfdcId: String, version: String): RestRequest
Builds a request that can fetch the actual binary file contents of this particular file.
Link copied to clipboard
open fun fileDetails(sfdcId: String, version: String): RestRequest
Build a Request that can fetch the file details of a particular version of a file.
Link copied to clipboard
open fun fileRendition(sfdcId: String, version: String, renditionType: RenditionType, pageNum: Integer): RestRequest
Build a Request that can fetch the a preview/rendition of a particular page of the file (and version).
Link copied to clipboard
open fun fileShares(sfdcId: String, pageNum: Integer): RestRequest
Build a Request that can fetch a page from the list of entities that this file is shared to.
Link copied to clipboard
open fun filesInUsersGroups(userId: String, pageNum: Integer): RestRequest
Build a Request that can fetch a page from the list of files from groups that the user is a member of.
Link copied to clipboard
open fun filesSharedWithUser(userId: String, pageNum: Integer): RestRequest
Build a Request that can fetch a page from the list of files that have been shared with the user.
Link copied to clipboard
Link copied to clipboard
open fun ownedFilesList(userId: String, pageNum: Integer): RestRequest
Build a Request that can fetch a page from the files owned by the specified user.
Link copied to clipboard
open fun uploadFile(theFile: File, name: String, title: String, description: String, mimeType: String): RestRequest
Build a request that can upload a new file to the server, this will create a new file at version 1.