com.salesforce.androidsdk.rest.files

Class FileRequests

java.lang.Object

com.salesforce.androidsdk.rest.files.FileRequests

public class FileRequests
extends java.lang.Object

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

Author:

sfell

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Map<java.lang.String,java.lang.String>	HTTP_HEADERS

Constructor Summary

Constructors

Constructor and Description
FileRequests()

Method Summary

Modifier and Type	Method and Description
static RestRequest	addFileShare(java.lang.String fileId, java.lang.String entityId, java.lang.String shareType) Build a request that will add a file share for the specified fileId to the specified entityId.
protected static ConnectUriBuilder	base(java.lang.String firstPathSegment)
static RestRequest	batchFileDetails(java.util.List<java.lang.String> sfdcIds) Build a request that can fetch the latest file details of one or more files in a single request.
static RestRequest	deleteFileShare(java.lang.String shareId) Build a request that will delete the specified file share.
static RestRequest	fileContents(java.lang.String sfdcId, java.lang.String version) Builds a request that can fetch the actual binary file contents of this particular file.
static RestRequest	fileDetails(java.lang.String sfdcId, java.lang.String version) Build a Request that can fetch the file details of a particular version of a file.
static RestRequest	fileRendition(java.lang.String sfdcId, java.lang.String version, RenditionType renditionType, java.lang.Integer pageNum) Build a Request that can fetch the a preview/rendition of a particular page of the file (and version).
static RestRequest	fileShares(java.lang.String sfdcId, java.lang.Integer pageNum) Build a Request that can fetch a page from the list of entities that this file is shared to.
static RestRequest	filesInUsersGroups(java.lang.String userId, java.lang.Integer pageNum) Build a Request that can fetch a page from the list of files from groups that the user is a member of.
static RestRequest	filesSharedWithUser(java.lang.String userId, java.lang.Integer pageNum) Build a Request that can fetch a page from the list of files that have been shared with the user.
static java.lang.String	getContentDocumentLinkPath()
protected static RestRequest	make(ConnectUriBuilder builder)
static RestRequest	ownedFilesList(java.lang.String userId, java.lang.Integer pageNum) Build a Request that can fetch a page from the files owned by the specified user.
static RestRequest	uploadFile(java.io.File theFile, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String mimeType) Build a request that can upload a new file to the server, this will create a new file at version 1.
protected static void	validateSfdcId(java.lang.String sfdcId)
protected static void	validateSfdcIds(java.util.List<java.lang.String> sfdcIds)
protected static void	validateSfdcIds(java.lang.String... sfdcIds)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTTP_HEADERS

protected static final java.util.Map<java.lang.String,java.lang.String> HTTP_HEADERS

Constructor Detail

FileRequests

public FileRequests()

Method Detail

getContentDocumentLinkPath

public static java.lang.String getContentDocumentLinkPath()

ownedFilesList

public static RestRequest ownedFilesList(java.lang.String userId,
                                         java.lang.Integer pageNum)

Build a Request that can fetch a page from the files owned by the specified user.

Parameters:

userId - If null the context user is used, otherwise it should be an Id of a user.

pageNum - If null fetches the first page, otherwise fetches the specified page.

Returns:

A new RestRequest that can be used to fetch this data.

filesInUsersGroups

public static RestRequest filesInUsersGroups(java.lang.String userId,
                                             java.lang.Integer pageNum)

Build a Request that can fetch a page from the list of files from groups that the user is a member of.

Parameters:

userId - If null the context user is used, otherwise it should be an Id of a user.

pageNum - If null fetches the first page, otherwise fetches the specified page.

Returns:

A new RestRequest that can be used to fetch this data.

filesSharedWithUser

public static RestRequest filesSharedWithUser(java.lang.String userId,
                                              java.lang.Integer pageNum)

Build a Request that can fetch a page from the list of files that have been shared with the user.

Parameters:

userId - If null the context user is used, otherwise it should be an Id of a user.

pageNum - If null fetches the first page, otherwise fetches the specified page.

Returns:

A new RestRequest that can be used to fetch this data.

fileDetails

public static RestRequest fileDetails(java.lang.String sfdcId,
                                      java.lang.String version)

Build a Request that can fetch the file details of a particular version of a file.

Parameters:

sfdcId - The Id of the file.

version - If null fetches the most recent version, otherwise fetches this specific version.

Returns:

A new RestRequest that can be used to fetch this data.

batchFileDetails

public static RestRequest batchFileDetails(java.util.List<java.lang.String> sfdcIds)

Build a request that can fetch the latest file details of one or more files in a single request.

Parameters:

sfdcIds - The list of file Ids to fetch.

Returns:

A new RestRequest that can be used to fetch this data.

fileRendition

public static RestRequest fileRendition(java.lang.String sfdcId,
                                        java.lang.String version,
                                        RenditionType renditionType,
                                        java.lang.Integer pageNum)

Build a Request that can fetch the a preview/rendition of a particular page of the file (and version).

Parameters:

sfdcId - The Id of the file.

version - If null fetches the most recent version, otherwise fetches this specific version.

renditionType - What format of rendition do you want to get.

pageNum - Which page to fetch, pages start at 0.

Returns:

A new RestRequest that can be used to fetch this data.

fileContents

public static RestRequest fileContents(java.lang.String sfdcId,
                                       java.lang.String version)

Builds a request that can fetch the actual binary file contents of this particular file.

Parameters:

sfdcId - The Id of the file.

version - The version of the file.

Returns:

A new RestRequest that can be used to fetch this data.

fileShares

public static RestRequest fileShares(java.lang.String sfdcId,
                                     java.lang.Integer pageNum)

Build a Request that can fetch a page from the list of entities that this file is shared to.

Parameters:

sfdcId - The Id of the file.

pageNum - If null fetches the first page, otherwise fetches the specified page.

Returns:

A new RestRequest that can be used to fetch this data.

addFileShare

public static RestRequest addFileShare(java.lang.String fileId,
                                       java.lang.String entityId,
                                       java.lang.String shareType)

Build a request that will add a file share for the specified fileId to the specified entityId.

Parameters:

fileId - The Id of the file being shared.

entityId - The Id of the entity to share the file to (e.g. a user or a group).

shareType - The type of share (V - View, C - Collaboration).

Returns:

A new RestRequest that be used to create this share.

deleteFileShare

public static RestRequest deleteFileShare(java.lang.String shareId)

Build a request that will delete the specified file share.

Parameters:

shareId - The Id of the file share record (aka ContentDocumentLink).

Returns:

A new RestRequest that be used to create this share.

uploadFile

public static RestRequest uploadFile(java.io.File theFile,
                                     java.lang.String name,
                                     java.lang.String title,
                                     java.lang.String description,
                                     java.lang.String mimeType)

Build a request that can upload a new file to the server, this will create a new file at version 1.

Parameters:

theFile - The path of the local file to upload to the server.

name - The name of this file.

title - The title of this file.

description - A description of the file.

mimeType - The mime-type of the file, if known.

Returns:

A RestRequest that can perform this upload.

make

protected static RestRequest make(ConnectUriBuilder builder)

base

protected static ConnectUriBuilder base(java.lang.String firstPathSegment)

validateSfdcId

protected static void validateSfdcId(java.lang.String sfdcId)

validateSfdcIds

protected static void validateSfdcIds(java.lang.String... sfdcIds)

validateSfdcIds

protected static void validateSfdcIds(java.util.List<java.lang.String> sfdcIds)