com.citrix.sharefile.api.entities

Class SFSharesEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFSharesEntity

public class SFSharesEntity
extends SFEntitiesBase

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFSharesEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<java.io.InputStream>	bulkDownload(java.net.URI shareUrl, java.lang.String aliasid, java.util.ArrayList<java.lang.String> ids) Download Multiple Items from a Share for a Recipient ["id1","id2",...] Download Multiple Items from a Share for a Recipient.
ISFQuery<java.io.InputStream>	bulkDownload(java.net.URI shareUrl, java.lang.String aliasid, java.util.ArrayList<java.lang.String> ids, java.lang.Boolean redirect) Download Multiple Items from a Share for a Recipient ["id1","id2",...] Download Multiple Items from a Share for a Recipient.
ISFQuery<SFShare>	create(SFShare share) Create Share { "ShareType":"Send", "Title":"Sample Send Share", "Items": [ { "Id":"itemid" }, {...} ], "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], "ExpirationDate": "2013-07-23", "RequireLogin": false, "RequireUserInfo": false, "MaxDownloads": -1, "UsesStreamIDs": false } { "ShareType":"Request", "Title":"Sample Request Share", "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], "Parent": { "Id":"folderid" }, "ExpirationDate": "2013-07-23", "RequireLogin": false, "RequireUserInfo": false, "TrackUntilDate": "2013-07-23", "SendFrequency": -1, "SendInterval": -1 } Creates a new Send or Request Share.
ISFQuery<SFShare>	create(SFShare share, java.lang.Boolean notify) Create Share { "ShareType":"Send", "Title":"Sample Send Share", "Items": [ { "Id":"itemid" }, {...} ], "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], "ExpirationDate": "2013-07-23", "RequireLogin": false, "RequireUserInfo": false, "MaxDownloads": -1, "UsesStreamIDs": false } { "ShareType":"Request", "Title":"Sample Request Share", "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], "Parent": { "Id":"folderid" }, "ExpirationDate": "2013-07-23", "RequireLogin": false, "RequireUserInfo": false, "TrackUntilDate": "2013-07-23", "SendFrequency": -1, "SendInterval": -1 } Creates a new Send or Request Share.
ISFQuery<SFShare>	createAlias(java.net.URI url, java.lang.String email) Create Share Alias Creates a share alias for the specified share ID and user email.
ISFQuery<SFShare>	createAlias(java.net.URI url, java.lang.String email, java.lang.Boolean notify) Create Share Alias Creates a share alias for the specified share ID and user email.
ISFQuery<SFShareAlias>	createRecipients(java.net.URI parentUrl) Create Recipient for a Share Creates a Recipient User for a Share that requires user information
ISFQuery<SFShareAlias>	createRecipients(java.net.URI parentUrl, java.lang.String Email) Create Recipient for a Share Creates a Recipient User for a Share that requires user information
ISFQuery<SFShareAlias>	createRecipients(java.net.URI parentUrl, java.lang.String Email, java.lang.String FirstName) Create Recipient for a Share Creates a Recipient User for a Share that requires user information
ISFQuery<SFShareAlias>	createRecipients(java.net.URI parentUrl, java.lang.String Email, java.lang.String FirstName, java.lang.String LastName) Create Recipient for a Share Creates a Recipient User for a Share that requires user information
ISFQuery<SFShareAlias>	createRecipients(java.net.URI parentUrl, java.lang.String Email, java.lang.String FirstName, java.lang.String LastName, java.lang.String Company) Create Recipient for a Share Creates a Recipient User for a Share that requires user information
ISFQuery	createRequest(SFShareRequestParams parameters) Deliver Request a File Email Sends an Email to the specified list of addresses, containing a link to files upload.
ISFQuery<SFShare>	createSend(SFShareSendParams parameters) Deliver Send a File Email Sends an Email to the specified list of addresses, containing a link to the specified Items.
ISFQuery	delete(java.net.URI url) Delete Share Removes an existing Share
ISFQuery<java.io.InputStream>	download(java.net.URI shareUrl) Downloads Share Items Downloads items from the Share.
ISFQuery<java.io.InputStream>	download(java.net.URI shareUrl, java.lang.String itemId) Downloads Share Items Downloads items from the Share.
ISFQuery<java.io.InputStream>	download(java.net.URI shareUrl, java.lang.String itemId, java.lang.String Name) Downloads Share Items Downloads items from the Share.
ISFQuery<java.io.InputStream>	download(java.net.URI shareUrl, java.lang.String itemId, java.lang.String Name, java.lang.String Email) Downloads Share Items Downloads items from the Share.
ISFQuery<java.io.InputStream>	download(java.net.URI shareUrl, java.lang.String itemId, java.lang.String Name, java.lang.String Email, java.lang.String Company) Downloads Share Items Downloads items from the Share.
ISFQuery<java.io.InputStream>	download(java.net.URI shareUrl, java.lang.String itemId, java.lang.String Name, java.lang.String Email, java.lang.String Company, java.lang.Boolean redirect) Downloads Share Items Downloads items from the Share.
ISFQuery<java.io.InputStream>	downloadWithAlias(java.net.URI shareUrl, java.lang.String aliasid) Download Items from a Share for a Recipient GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias?id=itemid GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias(itemid) Downloads items from the Share.
ISFQuery<java.io.InputStream>	downloadWithAlias(java.net.URI shareUrl, java.lang.String aliasid, java.lang.String itemId) Download Items from a Share for a Recipient GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias?id=itemid GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias(itemid) Downloads items from the Share.
ISFQuery<java.io.InputStream>	downloadWithAlias(java.net.URI shareUrl, java.lang.String aliasid, java.lang.String itemId, java.lang.Boolean redirect) Download Items from a Share for a Recipient GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias?id=itemid GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias(itemid) Downloads items from the Share.
ISFQuery<SFODataFeed<SFShare>>	get() Get List of Shares Retrieve all outstanding Shares of the authenticated user
ISFQuery<SFShare>	get(java.net.URI url) Get Share Retrieve a single Share entity.
ISFQuery<SFODataFeed<SFShare>>	getInbox() Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier
ISFQuery<SFODataFeed<SFShare>>	getInbox(java.lang.String userId) Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier
ISFQuery<SFODataFeed<SFShare>>	getInbox(java.lang.String userId, SFSafeEnum<SFShareType> type) Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier
ISFQuery<SFODataFeed<SFShare>>	getInbox(java.lang.String userId, SFSafeEnum<SFShareType> type, java.lang.Boolean archived) Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier
ISFQuery<SFODataFeed<SFItem>>	getItems(java.net.URI url) Get Items of a Share Retrieve the list of Items (files and folders) in the Send Share.
ISFQuery<SFItem>	getItems(java.net.URI shareUrl, java.lang.String itemid) Get Items of a Send Share Retrieve a single Item in the Send Share
ISFQuery<SFODataFeed<SFShareAlias>>	getRecipients(java.net.URI url) Get Recipients of a Share Retrieve the list of Recipients in the share.
ISFQuery<SFShareAlias>	getRecipients(java.net.URI parentUrl, java.lang.String id) Get Recipient of a Share Retrieve a single Share Recipient identified by the alias id.
ISFQuery<SFRedirection>	getRedirection(java.net.URI url) Get Redirection endpoint Information Returns the redirection endpoint for this Share.
ISFQuery<java.io.InputStream>	message(java.net.URI shareUrl, java.lang.String aliasId) Get Sent Message Content by Share Returns sent message content.
ISFQuery<SFODataFeed<SFItemProtocolLink>>	protocolLinks(java.net.URI shareUrl, java.lang.String itemid, SFSafeEnum<SFPreviewPlatform> platform) Get List of Protocol Links of a Share item
ISFQuery<SFShare>	resend(SFShareResendParams parameters) Deliver an existing share link to one or more recipients Sends an Email to the specified list of addresses, containing a link to a download or an upload.
ISFQuery<java.io.InputStream>	thumbnail(java.net.URI shareUrl, java.lang.String itemid) Get Thumbnail of a Share Item Retrieve a thumbnail link for the specified Item in the Share.
ISFQuery<java.io.InputStream>	thumbnail(java.net.URI shareUrl, java.lang.String itemid, java.lang.Integer size) Get Thumbnail of a Share Item Retrieve a thumbnail link for the specified Item in the Share.
ISFQuery<java.io.InputStream>	thumbnail(java.net.URI shareUrl, java.lang.String itemid, java.lang.Integer size, java.lang.Boolean redirect) Get Thumbnail of a Share Item Retrieve a thumbnail link for the specified Item in the Share.
ISFQuery<SFShare>	update(java.net.URI url, SFShare share) Update Share { "Title": "New Title", "ExpirationDate": "2013-07-23", "RequireLogin": false, "Items": [ { "Id":"itemid" }, {...} ], } Modifies an existing Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat, java.lang.Boolean notify) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat, java.lang.Boolean notify, java.util.Date clientCreatedDateUTC) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat, java.lang.Boolean notify, java.util.Date clientCreatedDateUTC, java.util.Date clientModifiedDateUTC) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload(java.net.URI url, SFSafeEnum<SFUploadMethod> method, java.lang.Boolean raw, java.lang.String fileName, java.lang.Long fileSize, java.lang.String batchId, java.lang.Boolean batchLast, java.lang.Boolean canResume, java.lang.Boolean startOver, java.lang.Boolean unzip, java.lang.String tool, java.lang.Boolean overwrite, java.lang.String title, java.lang.String details, java.lang.Boolean isSend, java.lang.String sendGuid, java.lang.String opid, java.lang.Integer threadCount, java.lang.String responseFormat, java.lang.Boolean notify, java.util.Date clientCreatedDateUTC, java.util.Date clientModifiedDateUTC, java.lang.Integer expirationDays) Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share.
ISFQuery<SFUploadSpecification>	upload2(java.net.URI url, SFUploadRequestParams uploadParams)
ISFQuery<SFUploadSpecification>	upload2(java.net.URI url, SFUploadRequestParams uploadParams, java.lang.Integer expirationDays)

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

SFSharesEntity

public SFSharesEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFODataFeed<SFShare>> get()

Get List of Shares Retrieve all outstanding Shares of the authenticated user

Returns:

List of Shares created by the authenticated user

get

public ISFQuery<SFShare> get(java.net.URI url)
                      throws InvalidOrMissingParameterException

Get Share Retrieve a single Share entity. If the Share allows anonymous access, then this method will not require authentication.

Parameters:

url -

Returns:

A single Share

Throws:

InvalidOrMissingParameterException

getRecipients

public ISFQuery<SFODataFeed<SFShareAlias>> getRecipients(java.net.URI url)
                                                  throws InvalidOrMissingParameterException

Get Recipients of a Share Retrieve the list of Recipients in the share. Recipients represent the target users of the Share, containing access information, such as number of times that user downloaded files from the share. Each Recipient is identified by an Alias, which is an unique ID given to each user - allowing tracking of downloads for non-authenticated users.

Parameters:

url -

Returns:

A feed of Share Aliases representing recipients of the Share

Throws:

InvalidOrMissingParameterException

getRecipients

public ISFQuery<SFShareAlias> getRecipients(java.net.URI parentUrl,
                                   java.lang.String id)
                                     throws InvalidOrMissingParameterException

Get Recipient of a Share Retrieve a single Share Recipient identified by the alias id.

Parameters:

parentUrl -

id -

Returns:

A Share Alias representing a single recipient of the Share

Throws:

InvalidOrMissingParameterException

createRecipients

public ISFQuery<SFShareAlias> createRecipients(java.net.URI parentUrl,
                                      java.lang.String Email,
                                      java.lang.String FirstName,
                                      java.lang.String LastName,
                                      java.lang.String Company)
                                        throws InvalidOrMissingParameterException

Create Recipient for a Share Creates a Recipient User for a Share that requires user information

Parameters:

parentUrl -

Email - (default: null)

FirstName - (default: null)

LastName - (default: null)

Company - (default: null)

Returns:

A Share Alias representing a single recipient of the Share

Throws:

InvalidOrMissingParameterException

createRecipients

public ISFQuery<SFShareAlias> createRecipients(java.net.URI parentUrl,
                                      java.lang.String Email,
                                      java.lang.String FirstName,
                                      java.lang.String LastName)
                                        throws InvalidOrMissingParameterException

Create Recipient for a Share Creates a Recipient User for a Share that requires user information

Parameters:

parentUrl -

Email - (default: null)

FirstName - (default: null)

LastName - (default: null)

Returns:

A Share Alias representing a single recipient of the Share

Throws:

InvalidOrMissingParameterException

createRecipients

public ISFQuery<SFShareAlias> createRecipients(java.net.URI parentUrl,
                                      java.lang.String Email,
                                      java.lang.String FirstName)
                                        throws InvalidOrMissingParameterException

Create Recipient for a Share Creates a Recipient User for a Share that requires user information

Parameters:

parentUrl -

Email - (default: null)

FirstName - (default: null)

Returns:

A Share Alias representing a single recipient of the Share

Throws:

InvalidOrMissingParameterException

createRecipients

public ISFQuery<SFShareAlias> createRecipients(java.net.URI parentUrl,
                                      java.lang.String Email)
                                        throws InvalidOrMissingParameterException

Create Recipient for a Share Creates a Recipient User for a Share that requires user information

Parameters:

parentUrl -

Email - (default: null)

Returns:

A Share Alias representing a single recipient of the Share

Throws:

InvalidOrMissingParameterException

createRecipients

public ISFQuery<SFShareAlias> createRecipients(java.net.URI parentUrl)
                                        throws InvalidOrMissingParameterException

Create Recipient for a Share Creates a Recipient User for a Share that requires user information

Parameters:

parentUrl -

Returns:

A Share Alias representing a single recipient of the Share

Throws:

InvalidOrMissingParameterException

getItems

public ISFQuery<SFODataFeed<SFItem>> getItems(java.net.URI url)
                                       throws InvalidOrMissingParameterException

Get Items of a Share Retrieve the list of Items (files and folders) in the Send Share.

Parameters:

url -

Returns:

A feed of Items of the Share

Throws:

InvalidOrMissingParameterException

getItems

public ISFQuery<SFItem> getItems(java.net.URI shareUrl,
                        java.lang.String itemid)
                          throws InvalidOrMissingParameterException

Get Items of a Send Share Retrieve a single Item in the Send Share

Parameters:

shareUrl -

Returns:

An item in the Share

Throws:

InvalidOrMissingParameterException

thumbnail

public ISFQuery<java.io.InputStream> thumbnail(java.net.URI shareUrl,
                                      java.lang.String itemid,
                                      java.lang.Integer size,
                                      java.lang.Boolean redirect)
                                        throws InvalidOrMissingParameterException

Get Thumbnail of a Share Item Retrieve a thumbnail link for the specified Item in the Share.

Parameters:

shareUrl -

size - (default: 75)

redirect - (default: false)

Returns:

A 302 redirection to the Thumbnail link

Throws:

InvalidOrMissingParameterException

thumbnail

public ISFQuery<java.io.InputStream> thumbnail(java.net.URI shareUrl,
                                      java.lang.String itemid,
                                      java.lang.Integer size)
                                        throws InvalidOrMissingParameterException

Get Thumbnail of a Share Item Retrieve a thumbnail link for the specified Item in the Share.

Parameters:

shareUrl -

size - (default: 75)

Returns:

A 302 redirection to the Thumbnail link

Throws:

InvalidOrMissingParameterException

thumbnail

public ISFQuery<java.io.InputStream> thumbnail(java.net.URI shareUrl,
                                      java.lang.String itemid)
                                        throws InvalidOrMissingParameterException

Get Thumbnail of a Share Item Retrieve a thumbnail link for the specified Item in the Share.

Parameters:

shareUrl -

Returns:

A 302 redirection to the Thumbnail link

Throws:

InvalidOrMissingParameterException

protocolLinks

public ISFQuery<SFODataFeed<SFItemProtocolLink>> protocolLinks(java.net.URI shareUrl,
                                                      java.lang.String itemid,
                                                      SFSafeEnum<SFPreviewPlatform> platform)
                                                        throws InvalidOrMissingParameterException

Get List of Protocol Links of a Share item

Parameters:

shareUrl -

Returns:

A list of protocol links depending on the input parameter 'platform', 404 (Not Found) if not supported by the item

Throws:

InvalidOrMissingParameterException

download

public ISFQuery<java.io.InputStream> download(java.net.URI shareUrl,
                                     java.lang.String itemId,
                                     java.lang.String Name,
                                     java.lang.String Email,
                                     java.lang.String Company,
                                     java.lang.Boolean redirect)
                                       throws InvalidOrMissingParameterException

Downloads Share Items Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require authentication, make sure this request is authenticated. To download shares that require require user information, provide the Name, Email and Company parameters in the URI query. Anyone can download files from anonymous shares.You can also download individual Items in the Share. Use the Share(id)/Items(id)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Parameters:

shareUrl -

Name - (default: null)

Email - (default: null)

Company - (default: null)

redirect - (default: true)

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

download

public ISFQuery<java.io.InputStream> download(java.net.URI shareUrl,
                                     java.lang.String itemId,
                                     java.lang.String Name,
                                     java.lang.String Email,
                                     java.lang.String Company)
                                       throws InvalidOrMissingParameterException

Downloads Share Items Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require authentication, make sure this request is authenticated. To download shares that require require user information, provide the Name, Email and Company parameters in the URI query. Anyone can download files from anonymous shares.You can also download individual Items in the Share. Use the Share(id)/Items(id)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Parameters:

shareUrl -

Name - (default: null)

Email - (default: null)

Company - (default: null)

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

download

public ISFQuery<java.io.InputStream> download(java.net.URI shareUrl,
                                     java.lang.String itemId,
                                     java.lang.String Name,
                                     java.lang.String Email)
                                       throws InvalidOrMissingParameterException

Downloads Share Items Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require authentication, make sure this request is authenticated. To download shares that require require user information, provide the Name, Email and Company parameters in the URI query. Anyone can download files from anonymous shares.You can also download individual Items in the Share. Use the Share(id)/Items(id)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Parameters:

shareUrl -

Name - (default: null)

Email - (default: null)

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

download

public ISFQuery<java.io.InputStream> download(java.net.URI shareUrl,
                                     java.lang.String itemId,
                                     java.lang.String Name)
                                       throws InvalidOrMissingParameterException

Downloads Share Items Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require authentication, make sure this request is authenticated. To download shares that require require user information, provide the Name, Email and Company parameters in the URI query. Anyone can download files from anonymous shares.You can also download individual Items in the Share. Use the Share(id)/Items(id)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Parameters:

shareUrl -

Name - (default: null)

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

download

public ISFQuery<java.io.InputStream> download(java.net.URI shareUrl,
                                     java.lang.String itemId)
                                       throws InvalidOrMissingParameterException

Downloads Share Items Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require authentication, make sure this request is authenticated. To download shares that require require user information, provide the Name, Email and Company parameters in the URI query. Anyone can download files from anonymous shares.You can also download individual Items in the Share. Use the Share(id)/Items(id)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Parameters:

shareUrl -

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

download

public ISFQuery<java.io.InputStream> download(java.net.URI shareUrl)
                                       throws InvalidOrMissingParameterException

Downloads Share Items Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require authentication, make sure this request is authenticated. To download shares that require require user information, provide the Name, Email and Company parameters in the URI query. Anyone can download files from anonymous shares.You can also download individual Items in the Share. Use the Share(id)/Items(id)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Parameters:

shareUrl -

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

downloadWithAlias

public ISFQuery<java.io.InputStream> downloadWithAlias(java.net.URI shareUrl,
                                              java.lang.String aliasid,
                                              java.lang.String itemId,
                                              java.lang.Boolean redirect)
                                                throws InvalidOrMissingParameterException

Download Items from a Share for a Recipient GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias?id=itemid GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias(itemid) Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require user informaion ( Email, First Name, Last Name and Company), make sure to create an Recipient (alias)To download Shares that require authentication, make sure this request is authenticated. Anyone can download files from anonymous shares.You can also download individual Items in the Share. Use the Shares(id)/Recipients(aliasid)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Parameters:

shareUrl -

redirect - (default: true)

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

downloadWithAlias

public ISFQuery<java.io.InputStream> downloadWithAlias(java.net.URI shareUrl,
                                              java.lang.String aliasid,
                                              java.lang.String itemId)
                                                throws InvalidOrMissingParameterException

Download Items from a Share for a Recipient GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias?id=itemid GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias(itemid) Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require user informaion ( Email, First Name, Last Name and Company), make sure to create an Recipient (alias)To download Shares that require authentication, make sure this request is authenticated. Anyone can download files from anonymous shares.You can also download individual Items in the Share. Use the Shares(id)/Recipients(aliasid)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Parameters:

shareUrl -

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

downloadWithAlias

public ISFQuery<java.io.InputStream> downloadWithAlias(java.net.URI shareUrl,
                                              java.lang.String aliasid)
                                                throws InvalidOrMissingParameterException

Download Items from a Share for a Recipient GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias?id=itemid GET https://account.sf-api.com/sf/v3/Shares(shareid)/Recipients(aliasid)/DownloadWithAlias(itemid) Downloads items from the Share. The default action will download all Items in the Share. If a Share has a single item, the download attachment name will use the item name. Otherwise, the download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require user informaion ( Email, First Name, Last Name and Company), make sure to create an Recipient (alias)To download Shares that require authentication, make sure this request is authenticated. Anyone can download files from anonymous shares.You can also download individual Items in the Share. Use the Shares(id)/Recipients(aliasid)/Download action. The item ID must be a top-level item in the Share - i.e., you cannot download or address files contained inside a shared folder.

Parameters:

shareUrl -

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

bulkDownload

public ISFQuery<java.io.InputStream> bulkDownload(java.net.URI shareUrl,
                                         java.lang.String aliasid,
                                         java.util.ArrayList<java.lang.String> ids,
                                         java.lang.Boolean redirect)
                                           throws InvalidOrMissingParameterException

Download Multiple Items from a Share for a Recipient ["id1","id2",...] Download Multiple Items from a Share for a Recipient. The download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require user informaion ( Email, First Name, Last Name and Company), make sure to create an Recipient (alias) and pass in the alaisId.To download Shares that require authentication, make sure this request is authenticated. Anyone can download files from anonymous shares.

Parameters:

shareUrl -

ids -

redirect - (default: true)

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

bulkDownload

public ISFQuery<java.io.InputStream> bulkDownload(java.net.URI shareUrl,
                                         java.lang.String aliasid,
                                         java.util.ArrayList<java.lang.String> ids)
                                           throws InvalidOrMissingParameterException

Download Multiple Items from a Share for a Recipient ["id1","id2",...] Download Multiple Items from a Share for a Recipient. The download will contain a ZIP archive containing all files and folders in the share, named Files.zip.To download Shares that require user informaion ( Email, First Name, Last Name and Company), make sure to create an Recipient (alias) and pass in the alaisId.To download Shares that require authentication, make sure this request is authenticated. Anyone can download files from anonymous shares.

Parameters:

shareUrl -

ids -

Returns:

Redirects the caller (302) to the download address for the share contents.

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFShare> create(SFShare share,
                       java.lang.Boolean notify)
                         throws InvalidOrMissingParameterException

Create Share { "ShareType":"Send", "Title":"Sample Send Share", "Items": [ { "Id":"itemid" }, {...} ], "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], "ExpirationDate": "2013-07-23", "RequireLogin": false, "RequireUserInfo": false, "MaxDownloads": -1, "UsesStreamIDs": false } { "ShareType":"Request", "Title":"Sample Request Share", "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], "Parent": { "Id":"folderid" }, "ExpirationDate": "2013-07-23", "RequireLogin": false, "RequireUserInfo": false, "TrackUntilDate": "2013-07-23", "SendFrequency": -1, "SendInterval": -1 } Creates a new Send or Request Share. Expiration date: - if not specified the default is 30 days - "9999-12-31" disables share expiration. To use stream IDs as item IDs UsesStreamIDs needs to be set to true, and all the IDs in Items need to be specified as stream IDs.

Parameters:

share -

notify - (default: false)

Returns:

The new Share

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFShare> create(SFShare share)
                         throws InvalidOrMissingParameterException

Create Share { "ShareType":"Send", "Title":"Sample Send Share", "Items": [ { "Id":"itemid" }, {...} ], "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], "ExpirationDate": "2013-07-23", "RequireLogin": false, "RequireUserInfo": false, "MaxDownloads": -1, "UsesStreamIDs": false } { "ShareType":"Request", "Title":"Sample Request Share", "Recipients":[ { "User": { "Id":"userid" } }, { "User": { "Email": "user@email" } } ], "Parent": { "Id":"folderid" }, "ExpirationDate": "2013-07-23", "RequireLogin": false, "RequireUserInfo": false, "TrackUntilDate": "2013-07-23", "SendFrequency": -1, "SendInterval": -1 } Creates a new Send or Request Share. Expiration date: - if not specified the default is 30 days - "9999-12-31" disables share expiration. To use stream IDs as item IDs UsesStreamIDs needs to be set to true, and all the IDs in Items need to be specified as stream IDs.

Parameters:

share -

Returns:

The new Share

Throws:

InvalidOrMissingParameterException

update

public ISFQuery<SFShare> update(java.net.URI url,
                       SFShare share)
                         throws InvalidOrMissingParameterException

Update Share { "Title": "New Title", "ExpirationDate": "2013-07-23", "RequireLogin": false, "Items": [ { "Id":"itemid" }, {...} ], } Modifies an existing Share. If Items are specified they are added to the share.

Parameters:

url -

share -

Returns:

The modified Share

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url)
                throws InvalidOrMissingParameterException

Delete Share Removes an existing Share

Parameters:

url -

Throws:

InvalidOrMissingParameterException

createAlias

public ISFQuery<SFShare> createAlias(java.net.URI url,
                            java.lang.String email,
                            java.lang.Boolean notify)
                              throws InvalidOrMissingParameterException

Create Share Alias Creates a share alias for the specified share ID and user email. If a user with the given email address does not exist it is created first. For shares requiring login an activation email is sent to the created user. If 'notify' is enabled, the user activation is included in the share notification email.

Parameters:

url -

email -

notify - (default: false)

Returns:

Share with the AliasID property set to the created alias ID

Throws:

InvalidOrMissingParameterException

createAlias

public ISFQuery<SFShare> createAlias(java.net.URI url,
                            java.lang.String email)
                              throws InvalidOrMissingParameterException

Create Share Alias Creates a share alias for the specified share ID and user email. If a user with the given email address does not exist it is created first. For shares requiring login an activation email is sent to the created user. If 'notify' is enabled, the user activation is included in the share notification email.

Parameters:

url -

email -

Returns:

Share with the AliasID property set to the created alias ID

Throws:

InvalidOrMissingParameterException

createSend

public ISFQuery<SFShare> createSend(SFShareSendParams parameters)
                             throws InvalidOrMissingParameterException

Deliver Send a File Email Sends an Email to the specified list of addresses, containing a link to the specified Items. The default number of expiration days is 30. -1 disables share expiration.

Parameters:

parameters -

Returns:

The new Share

Throws:

InvalidOrMissingParameterException

createRequest

public ISFQuery createRequest(SFShareRequestParams parameters)
                       throws InvalidOrMissingParameterException

Deliver Request a File Email Sends an Email to the specified list of addresses, containing a link to files upload. The default number of expiration days is 30. -1 disables share expiration.

Parameters:

parameters -

Throws:

InvalidOrMissingParameterException

resend

public ISFQuery<SFShare> resend(SFShareResendParams parameters)
                         throws InvalidOrMissingParameterException

Deliver an existing share link to one or more recipients Sends an Email to the specified list of addresses, containing a link to a download or an upload.

Parameters:

parameters -

Returns:

The updated Share

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat,
                                     java.lang.Boolean notify,
                                     java.util.Date clientCreatedDateUTC,
                                     java.util.Date clientModifiedDateUTC,
                                     java.lang.Integer expirationDays)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

isSend - (default: false)

sendGuid - (default: null)

opid - (default: null)

threadCount - (default: 4)

responseFormat - (default: "json")

notify - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat,
                                     java.lang.Boolean notify,
                                     java.util.Date clientCreatedDateUTC,
                                     java.util.Date clientModifiedDateUTC)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

isSend - (default: false)

sendGuid - (default: null)

opid - (default: null)

threadCount - (default: 4)

responseFormat - (default: "json")

notify - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat,
                                     java.lang.Boolean notify,
                                     java.util.Date clientCreatedDateUTC)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

isSend - (default: false)

sendGuid - (default: null)

opid - (default: null)

threadCount - (default: 4)

responseFormat - (default: "json")

notify - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat,
                                     java.lang.Boolean notify)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

isSend - (default: false)

sendGuid - (default: null)

opid - (default: null)

threadCount - (default: 4)

responseFormat - (default: "json")

notify - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount,
                                     java.lang.String responseFormat)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

isSend - (default: false)

sendGuid - (default: null)

opid - (default: null)

threadCount - (default: 4)

responseFormat - (default: "json")

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid,
                                     java.lang.Integer threadCount)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

isSend - (default: false)

sendGuid - (default: null)

opid - (default: null)

threadCount - (default: 4)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid,
                                     java.lang.String opid)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

isSend - (default: false)

sendGuid - (default: null)

opid - (default: null)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend,
                                     java.lang.String sendGuid)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

isSend - (default: false)

sendGuid - (default: null)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details,
                                     java.lang.Boolean isSend)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

isSend - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title,
                                     java.lang.String details)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

details - (default: null)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite,
                                     java.lang.String title)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

title - (default: null)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool,
                                     java.lang.Boolean overwrite)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

overwrite - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip,
                                     java.lang.String tool)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

tool - (default: "apiv3")

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver,
                                     java.lang.Boolean unzip)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

unzip - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume,
                                     java.lang.Boolean startOver)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

startOver - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast,
                                     java.lang.Boolean canResume)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

canResume - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId,
                                     java.lang.Boolean batchLast)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

batchLast - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize,
                                     java.lang.String batchId)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

batchId - (default: null)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName,
                                     java.lang.Long fileSize)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

fileSize - (default: 0)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw,
                                     java.lang.String fileName)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

fileName - (default: null)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method,
                                     java.lang.Boolean raw)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

raw - (default: false)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url,
                                     SFSafeEnum<SFUploadMethod> method)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

method - (default: Standard)

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload

public ISFQuery<SFUploadSpecification> upload(java.net.URI url)
                                       throws InvalidOrMissingParameterException

Upload File to Request Share POST https://account.sf-api.com/sf/v3/Shares(id)/Upload2 { "Method":"Method", "Raw": false, "FileName":"FileName" "FileLength": length } Prepares the links for uploading files to the target Share. This method returns an Upload Specification object. The fields are populated based on the upload method, provider, and resume parameters passed to the upload call. The Method determines how the URLs must be called. Standard uploads use a single HTTP POST message to the ChunkUri address provided in the response. All other fields will be empty. Standard uploads do not support Resume. Streamed uploads use multiple HTTP POST calls to the ChunkUri address. The client must append the parameters index, offset and hash to the end of the ChunkUri address. Index is a sequential number representing the data block (zero-based); Offset represents the byte offset for the block; and hash contains the MD5 hash of the block. The last HTTP POST must also contain finish=true parameter. Threaded uploads use multiple HTTP POST calls to ChunkUri, and can have a number of threads issuing blocks in parallel. Clients must append index, offset and hash to the end of ChunkUri, as explained in Streamed. After all chunks were sent, the client must call the FinishUri provided in this spec. For all uploaders, the contents of the POST Body can either be "raw", if the "Raw" parameter was provided to the Uploader, or use MIME multi-part form encoding otherwise. Raw uploads simply put the block content in the POST body - Content-Length specifies the size. Multi-part form encoding has to pass the File as a Form parameter named "File1". For streamed and threaded, if Resume options were provided to the Upload call, then the fields IsResume, ResumeIndex, ResumeOffset and ResumeFileHash MAY be populated. If they are, it indicates that the server has identified a partial upload with that specification, and is ready to resume on the provided parameters. The clients can then verify the ResumeFileHash to ensure the file has not been modified; and continue issuing ChunkUri calls from the ResumeIndex ResumeOffset parameters. If the client decides to restart, it should simply ignore the resume parameters and send the blocks from Index 0. For all uploaders: the result code for the HTTP POST calls to Chunk and Finish Uri can either be a 401 - indicating authentication is required; 4xx/5xx indicating some kind of error; or 200 with a Content Body of format 'ERROR:message'. Successful calls will return either a 200 response with no Body, or with Body of format 'OK'.

Parameters:

url -

Returns:

an Upload Specification element, containing the links for uploading, and the parameters for resume. The caller must know the protocol for sending the prepare, chunk and finish URLs returned in the spec; as well as negotiate the resume upload.

Throws:

InvalidOrMissingParameterException

upload2

public ISFQuery<SFUploadSpecification> upload2(java.net.URI url,
                                      SFUploadRequestParams uploadParams,
                                      java.lang.Integer expirationDays)
                                        throws InvalidOrMissingParameterException

Throws:

InvalidOrMissingParameterException

upload2

public ISFQuery<SFUploadSpecification> upload2(java.net.URI url,
                                      SFUploadRequestParams uploadParams)
                                        throws InvalidOrMissingParameterException

Throws:

InvalidOrMissingParameterException

getRedirection

public ISFQuery<SFRedirection> getRedirection(java.net.URI url)
                                       throws InvalidOrMissingParameterException

Get Redirection endpoint Information Returns the redirection endpoint for this Share.

Parameters:

url -

Returns:

The Redirection endpoint Information

Throws:

InvalidOrMissingParameterException

getInbox

public ISFQuery<SFODataFeed<SFShare>> getInbox(java.lang.String userId,
                                      SFSafeEnum<SFShareType> type,
                                      java.lang.Boolean archived)
                                        throws InvalidOrMissingParameterException

Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier

Returns:

List of Shares created by the authenticated user

Throws:

InvalidOrMissingParameterException

getInbox

public ISFQuery<SFODataFeed<SFShare>> getInbox(java.lang.String userId,
                                      SFSafeEnum<SFShareType> type)
                                        throws InvalidOrMissingParameterException

Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier

Returns:

List of Shares created by the authenticated user

Throws:

InvalidOrMissingParameterException

getInbox

public ISFQuery<SFODataFeed<SFShare>> getInbox(java.lang.String userId)
                                        throws InvalidOrMissingParameterException

Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier

Returns:

List of Shares created by the authenticated user

Throws:

InvalidOrMissingParameterException

getInbox

public ISFQuery<SFODataFeed<SFShare>> getInbox()

Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier

Returns:

List of Shares created by the authenticated user

message

public ISFQuery<java.io.InputStream> message(java.net.URI shareUrl,
                                    java.lang.String aliasId)
                                      throws InvalidOrMissingParameterException

Get Sent Message Content by Share Returns sent message content.

Parameters:

shareUrl -

Returns:

Sent Message Content

Throws:

InvalidOrMissingParameterException