com.citrix.sharefile.api.models

Class SFShareSendParams

java.lang.Object

com.citrix.sharefile.api.models.SFODataObject

com.citrix.sharefile.api.models.SFShareSendParams

public class SFShareSendParams
extends SFODataObject

Constructor Summary

Constructors

Constructor and Description
SFShareSendParams()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBody() A message to be included in the Share email body
java.lang.Boolean	getCcSender() If true, the Share sender will be cc'd in the Share email
java.util.ArrayList<java.lang.String>	getEmails() List of emails to whom this Share should be sent
java.lang.Integer	getExpirationDays() Number of days until access to this Share expires
java.lang.Boolean	getIsViewOnly() If true, the Share items can only be viewed but not downloaded.
java.util.ArrayList<java.lang.String>	getItems() List of Item Ids to be sent
java.lang.Integer	getMaxDownloads() Maximum number of times each recipient can download the Share items
java.lang.Boolean	getNotifyOnDownload() If true, the sender will receive an email notification when the Share items are downloaded
java.lang.Boolean	getRequireLogin() If true, recipients will need to login to access the Share
java.lang.Boolean	getRequireUserInfo() If true, a recipient will need to provide their full name and email to access the Share.
java.lang.Boolean	getSendAnon() If true, anyone with the link can access the Share.
SFShareAccessRight	getShareAccessRight() Used to define the share type and share action types
java.lang.String	getSubject() The subject of the Share email
java.lang.Boolean	getUsesStreamIDs() When enabled the items are identified by stream IDs instead of item IDs.
void	setBody(java.lang.String body) A message to be included in the Share email body
void	setCcSender(java.lang.Boolean ccsender) If true, the Share sender will be cc'd in the Share email
void	setEmails(java.util.ArrayList<java.lang.String> emails) List of emails to whom this Share should be sent
void	setExpirationDays(java.lang.Integer expirationdays) Number of days until access to this Share expires
void	setIsViewOnly(java.lang.Boolean isviewonly) If true, the Share items can only be viewed but not downloaded.
void	setItems(java.util.ArrayList<java.lang.String> items) List of Item Ids to be sent
void	setMaxDownloads(java.lang.Integer maxdownloads) Maximum number of times each recipient can download the Share items
void	setNotifyOnDownload(java.lang.Boolean notifyondownload) If true, the sender will receive an email notification when the Share items are downloaded
void	setRequireLogin(java.lang.Boolean requirelogin) If true, recipients will need to login to access the Share
void	setRequireUserInfo(java.lang.Boolean requireuserinfo) If true, a recipient will need to provide their full name and email to access the Share.
void	setSendAnon(java.lang.Boolean sendanon) If true, anyone with the link can access the Share.
void	setShareAccessRight(SFShareAccessRight shareaccessright) Used to define the share type and share action types
void	setSubject(java.lang.String subject) The subject of the Share email
void	setUsesStreamIDs(java.lang.Boolean usesstreamids) When enabled the items are identified by stream IDs instead of item IDs.

Methods inherited from class com.citrix.sharefile.api.models.SFODataObject

addProperty, get__type, getId, getMetadataUrl, getProperties, geturl, set__type, setId, setMetadataUrl, setProperties, seturl

Methods inherited from class java.lang.Object

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

Constructor Detail

SFShareSendParams

public SFShareSendParams()

Method Detail

getItems

public java.util.ArrayList<java.lang.String> getItems()

List of Item Ids to be sent

setItems

public void setItems(java.util.ArrayList<java.lang.String> items)

List of Item Ids to be sent

getEmails

public java.util.ArrayList<java.lang.String> getEmails()

List of emails to whom this Share should be sent

setEmails

public void setEmails(java.util.ArrayList<java.lang.String> emails)

List of emails to whom this Share should be sent

getSubject

public java.lang.String getSubject()

The subject of the Share email

setSubject

public void setSubject(java.lang.String subject)

The subject of the Share email

getBody

public java.lang.String getBody()

A message to be included in the Share email body

setBody

public void setBody(java.lang.String body)

A message to be included in the Share email body

getCcSender

public java.lang.Boolean getCcSender()

If true, the Share sender will be cc'd in the Share email

setCcSender

public void setCcSender(java.lang.Boolean ccsender)

If true, the Share sender will be cc'd in the Share email

getRequireLogin

public java.lang.Boolean getRequireLogin()

If true, recipients will need to login to access the Share

setRequireLogin

public void setRequireLogin(java.lang.Boolean requirelogin)

If true, recipients will need to login to access the Share

getSendAnon

public java.lang.Boolean getSendAnon()

If true, anyone with the link can access the Share. Cannot be true if RequireLogin is true

setSendAnon

public void setSendAnon(java.lang.Boolean sendanon)

If true, anyone with the link can access the Share. Cannot be true if RequireLogin is true

getRequireUserInfo

public java.lang.Boolean getRequireUserInfo()

If true, a recipient will need to provide their full name and email to access the Share. Cannot be true if RequireLogin is true

setRequireUserInfo

public void setRequireUserInfo(java.lang.Boolean requireuserinfo)

If true, a recipient will need to provide their full name and email to access the Share. Cannot be true if RequireLogin is true

getExpirationDays

public java.lang.Integer getExpirationDays()

Number of days until access to this Share expires

setExpirationDays

public void setExpirationDays(java.lang.Integer expirationdays)

Number of days until access to this Share expires

getNotifyOnDownload

public java.lang.Boolean getNotifyOnDownload()

If true, the sender will receive an email notification when the Share items are downloaded

setNotifyOnDownload

public void setNotifyOnDownload(java.lang.Boolean notifyondownload)

If true, the sender will receive an email notification when the Share items are downloaded

getIsViewOnly

public java.lang.Boolean getIsViewOnly()

If true, the Share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work

setIsViewOnly

public void setIsViewOnly(java.lang.Boolean isviewonly)

If true, the Share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work

getMaxDownloads

public java.lang.Integer getMaxDownloads()

Maximum number of times each recipient can download the Share items

setMaxDownloads

public void setMaxDownloads(java.lang.Integer maxdownloads)

Maximum number of times each recipient can download the Share items

getUsesStreamIDs

public java.lang.Boolean getUsesStreamIDs()

When enabled the items are identified by stream IDs instead of item IDs. Applies to Send Shares only. (FINRA enabled accounts cannot use this)

setUsesStreamIDs

public void setUsesStreamIDs(java.lang.Boolean usesstreamids)

When enabled the items are identified by stream IDs instead of item IDs. Applies to Send Shares only. (FINRA enabled accounts cannot use this)

getShareAccessRight

public SFShareAccessRight getShareAccessRight()

Used to define the share type and share action types

setShareAccessRight

public void setShareAccessRight(SFShareAccessRight shareaccessright)

Used to define the share type and share action types