Transfer (java-api 5.0.1)

java.lang.Object
- com.cryptshare.api.Transfer

```
public class Transfer
extends java.lang.Object
```
Contains the transfer information required for a specific Cryptshare transfer

Constructor Summary

Constructors
Constructor and Description
`Transfer()` Creates a new Transfer instance with the following transfer default values: showFilenames = true downloadNotification = true sendMails = true recipientLanguage = "en"

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFile(TransferFile transferFile)` Adds a transfer file to this transfer.
`void`	`addRecipient(Recipient recipient)` Adds a recipient to the recipients list.
`void`	`addRecipients(java.util.List<Recipient> recipients)` Adds the given list of recipients to the transfer's recipient list.
`long`	`calculateTransferSize()` Calculates the size of the transfer, based on the given transfer files.
`java.lang.String`	`getClassificationId()` Returns the ID of the classification.
`java.lang.String`	`getConfidentialMessage()` Returns the confidential message text for this transfer.
`java.lang.String`	`getConfidentialSubject()` Returns the confidentialSubject text for this transfer.
`java.time.LocalDate`	`getExpirationDate()` Returns the expiration date of the transfer..
`java.lang.String`	`getMessage()` Returns the message text for this transfer.
`java.lang.String`	`getPassword()` Returns the transfer password.
`PasswordMode`	`getPasswordMode()` Returns the `PasswordMode` for the transfer.
`java.util.Locale`	`getRecipientLanguage()` Returns the language used for recipient notifications.
`java.util.List<Recipient>`	`getRecipients()` Returns the recipients of the transfer, specified as `List` of `Recipient`s.
`java.lang.String`	`getSenderName()` Returns the name of the sender.
`java.lang.String`	`getSenderPhone()` Returns the telephone number of the sender.
`java.lang.String`	`getSubject()` Returns the subject text for this transfer.
`java.lang.String`	`getTrackingId()` Returns the tracking ID, which identifies the transfer on the server.
`java.util.List<TransferFile>`	`getTransferFiles()` Returns the files of the transfer, specified as `List` of `TransferFile`s.
`boolean`	`isInformAboutDownload()` Returns whether a notification about the retrieval of a transfer file will be sent.
`boolean`	`isNotifyRecipients()` Returns whether the recipients will be notified after the upload.
`boolean`	`isNotifySender()` Returns whether the sender will be notified after the upload.
`boolean`	`isSendDownloadSummary()` Returns whether a download summary will be sent to the sender once the transfer has expired.
`boolean`	`isSendMails()` Returns whether the server will send emails or not.
`boolean`	`isShowFilenames()` Returns whether file names are being exposed or not.
`void`	`setClassificationId(java.lang.String classificationId)` Sets the ID of the classification.
`void`	`setConfidentialMessage(java.io.InputStream messageStream)` Sets the confidential message text for this transfer from the given input stream.
`void`	`setConfidentialMessage(java.lang.String message)` Sets the confidential message for this transfer.
`void`	`setConfidentialSubject(java.io.InputStream subjectStream)` Sets the confidential subject text for this transfer from the given input stream.
`void`	`setConfidentialSubject(java.lang.String subject)` Sets the confidential subject text for this transfer.
`void`	`setExpirationDate(java.time.LocalDate expirationDate)` Sets the expiration date of the transfer.
`void`	`setInformAboutDownload(boolean value)` Sets the download notification option.
`void`	`setMessage(java.io.InputStream messageStream)` Sets the message text for this transfer from the given input stream.
`void`	`setMessage(java.lang.String message)` Sets the message for this transfer.
`void`	`setNotifyRecipients(boolean notifyRecipients)` Sets whether the recipients will be notified after the upload.
`void`	`setNotifySender(boolean notifySender)` Sets whether the sender will be notified after the upload.
`void`	`setPassword(java.lang.String password)` Sets the transfer password.
`void`	`setPasswordMode(PasswordMode passwordMode)` Sets the `PasswordMode` for the transfer.
`void`	`setRecipientLanguage(java.util.Locale language)` Sets the language used for recipient notifications.
`void`	`setRecipients(java.util.List<Recipient> recipients)` Sets the recipients of the transfer, specified as `List` of `Recipient`s.
`void`	`setSendDownloadSummary(boolean sendDownloadSummary)` Sets whether a download summary should be sent to the sender once the transfer has expired.
`void`	`setSenderName(java.lang.String value)` Sets the name of the sender.
`void`	`setSenderPhone(java.lang.String phone)` Sets the telephone number of the sender.
`void`	`setSendMails(boolean value)` Sets whether the server will send emails or not.
`void`	`setShowFilenames(boolean value)` Sets whether file names are being exposed or not.
`void`	`setSubject(java.io.InputStream subjectStream)` Sets the subject text for this transfer from the given input stream.
`void`	`setSubject(java.lang.String subject)` Sets the subject text for this transfer.
`void`	`setTransferFiles(java.util.List<TransferFile> transferFiles)` Sets the files of the transfer, specified as `List` of `TransferFile`s.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Transfer
```
public Transfer()
```
    Creates a new Transfer instance with the following transfer default values:
    
    showFilenames = true
    downloadNotification = true
    sendMails = true
    recipientLanguage = "en"
- Method Detail
  - calculateTransferSize
```
public long calculateTransferSize()
                           throws java.io.IOException
```
    Calculates the size of the transfer, based on the given transfer files.
    
    Returns:
    
    The size of the transfer, in bytes.
    
    Throws:
    
    java.io.IOException - If one of the transfer files cannot be read.
  - setExpirationDate
```
public void setExpirationDate(java.time.LocalDate expirationDate)
```
    Sets the expiration date of the transfer.
    
    Parameters:
    
    expirationDate - The expiration date.
  - getExpirationDate
```
public java.time.LocalDate getExpirationDate()
```
    Returns the expiration date of the transfer..
    
    Returns:
    
    The expiration date.
  - setSenderName
```
public void setSenderName(java.lang.String value)
```
    Sets the name of the sender.
    
    Parameters:
    
    value - The sender name.
  - getSenderName
```
public java.lang.String getSenderName()
```
    Returns the name of the sender.
    
    Returns:
    
    The sender name.
  - setSenderPhone
```
public void setSenderPhone(java.lang.String phone)
```
    Sets the telephone number of the sender.
    
    Parameters:
    
    phone - The telephone number of the sender.
  - getSenderPhone
```
public java.lang.String getSenderPhone()
```
    Returns the telephone number of the sender.
    
    Returns:
    
    The telephone number of the sender.
  - setMessage
```
public void setMessage(java.lang.String message)
```
    Sets the message for this transfer.
    
    Parameters:
    
    message - The message text.
  - setMessage
```
public void setMessage(java.io.InputStream messageStream)
                throws java.io.IOException
```
    Sets the message text for this transfer from the given input stream. The encoding used to read the stream is UTF-8, so only streams encoded with UTF-8 will be read in correctly. The input stream will automatically be closed after this operation.
    
    Parameters:
    
    messageStream - The input stream containing the text.
    
    Throws:
    
    java.io.IOException - If the input stream could not be read.
  - getMessage
```
public java.lang.String getMessage()
```
    Returns the message text for this transfer.
    
    Returns:
    
    The message text.
  - setSubject
```
public void setSubject(java.lang.String subject)
```
    Sets the subject text for this transfer. If the subject text is longer than 100 characters, the text will be shortened accordingly during the transfer.
    
    Parameters:
    
    subject - The subject text.
  - setSubject
```
public void setSubject(java.io.InputStream subjectStream)
                throws java.io.IOException
```
    Sets the subject text for this transfer from the given input stream. The encoding used to read the stream is UTF-8, so only streams encoded with UTF-8 will be read in correctly. The input stream will automatically be closed after this operation. If the subject text is longer than 100 characters, the text will be shortened accordingly during the transfer.
    
    Parameters:
    
    subjectStream - The input stream containing the text.
    
    Throws:
    
    java.io.IOException - If the input stream could not be read.
  - getSubject
```
public java.lang.String getSubject()
```
    Returns the subject text for this transfer.
    
    Returns:
    
    The subject text.
  - setConfidentialMessage
```
public void setConfidentialMessage(java.lang.String message)
```
    Sets the confidential message for this transfer.
    
    Parameters:
    
    message - The confidential message text.
  - setConfidentialMessage
```
public void setConfidentialMessage(java.io.InputStream messageStream)
                            throws java.io.IOException
```
    Sets the confidential message text for this transfer from the given input stream. The encoding used to read the stream is UTF-8, so only streams encoded with UTF-8 will be read in correctly. The input stream will automatically be closed after this operation.
    
    Parameters:
    
    messageStream - The input stream containing the text.
    
    Throws:
    
    java.io.IOException - If the input stream could not be read.
  - getConfidentialMessage
```
public java.lang.String getConfidentialMessage()
```
    Returns the confidential message text for this transfer.
    
    Returns:
    
    The confidential message text.
  - setConfidentialSubject
```
public void setConfidentialSubject(java.lang.String subject)
```
    Sets the confidential subject text for this transfer. If the subject text is longer than 100 characters, the text will be shortened accordingly during the transfer.
    
    Parameters:
    
    subject - The confidential subject text.
  - setConfidentialSubject
```
public void setConfidentialSubject(java.io.InputStream subjectStream)
                            throws java.io.IOException
```
    Sets the confidential subject text for this transfer from the given input stream. The encoding used to read the stream is UTF-8, so only streams encoded with UTF-8 will be read in correctly. The input stream will automatically be closed after this operation. If the subject text is longer than 100 characters, the text will be shortened accordingly during the transfer.
    
    Parameters:
    
    subjectStream - The input stream containing the text.
    
    Throws:
    
    java.io.IOException - If the input stream could not be read.
  - getConfidentialSubject
```
public java.lang.String getConfidentialSubject()
```
    Returns the confidentialSubject text for this transfer.
    
    Returns:
    
    The confidential subject text.
  - isShowFilenames
```
public boolean isShowFilenames()
```
    Returns whether file names are being exposed or not.
    
    Returns:
    
    true, if filenames will be shown in the email notifications, false otherwise.
  - setShowFilenames
```
public void setShowFilenames(boolean value)
```
    Sets whether file names are being exposed or not.
    
    Parameters:
    
    value - true, if filenames are to be shown the email notifications, false otherwise.
  - isNotifySender
```
public boolean isNotifySender()
```
    Returns whether the sender will be notified after the upload. This has no effect if isSendMails() is false.
    
    Returns:
    
    true if the sender will be notified when a transfer has been made available to the recipients, false otherwise.
  - setNotifySender
```
public void setNotifySender(boolean notifySender)
```
    Sets whether the sender will be notified after the upload. This has no effect if isSendMails() is false.
    
    Parameters:
    
    notifySender - true if the sender should be notified when a transfer has been made available to the recipients, false otherwise.
  - isNotifyRecipients
```
public boolean isNotifyRecipients()
```
    Returns whether the recipients will be notified after the upload. This has no effect if isSendMails() is false.
    
    Returns:
    
    true if the recipients will be notified when a transfer has been made available, false otherwise.
  - setNotifyRecipients
```
public void setNotifyRecipients(boolean notifyRecipients)
```
    Sets whether the recipients will be notified after the upload. This has no effect if isSendMails() is false.
    
    Parameters:
    
    notifyRecipients - true if the recipients should be notified when a transfer has been made available, false otherwise.
  - isInformAboutDownload
```
public boolean isInformAboutDownload()
```
    Returns whether a notification about the retrieval of a transfer file will be sent. This has no effect if isSendMails() is false.
    
    Returns:
    
    true, if the sender of the transfer will be informed when a download of a file has started, false otherwise.
  - setInformAboutDownload
```
public void setInformAboutDownload(boolean value)
```
    Sets the download notification option. If set to true, the sender of the transfer will be notified when a download of a file has been started. This has no effect if isSendMails() is false.
    
    Parameters:
    
    value - true, if sender should be notified of a download, false otherwise.
  - isSendDownloadSummary
```
public boolean isSendDownloadSummary()
```
    Returns whether a download summary will be sent to the sender once the transfer has expired.
    
    Returns:
    
    true if the download summary will be sent, false otherwise.
  - setSendDownloadSummary
```
public void setSendDownloadSummary(boolean sendDownloadSummary)
```
    Sets whether a download summary should be sent to the sender once the transfer has expired.
    
    Parameters:
    
    sendDownloadSummary - true if the download summary will be sent, false otherwise.
  - isSendMails
```
public boolean isSendMails()
```
    Returns whether the server will send emails or not.
    
    Returns:
    
    true, if the server will send any emails for this transfer at all, false otherwise.
  - setSendMails
```
public void setSendMails(boolean value)
```
    Sets whether the server will send emails or not.
    
    Parameters:
    
    value - true, if the server should send any emails for this transfer at all, false otherwise.
  - getRecipients
```
public java.util.List<Recipient> getRecipients()
```
    Returns the recipients of the transfer, specified as List of Recipients.
    
    Returns:
    
    The list of recipients of this transfer, never null.
  - setRecipients
```
public void setRecipients(java.util.List<Recipient> recipients)
```
    Sets the recipients of the transfer, specified as List of Recipients. All elements of this list are added to the recipient list.
    
    Parameters:
    
    recipients - The new list of recipients for this transfer.
  - addRecipient
```
public void addRecipient(Recipient recipient)
```
    Adds a recipient to the recipients list.
    
    Parameters:
    
    recipient - The Recipient to add.
  - addRecipients
```
public void addRecipients(java.util.List<Recipient> recipients)
```
    Adds the given list of recipients to the transfer's recipient list.
    
    Parameters:
    
    recipients - The list of Recipients to add.
  - getTransferFiles
```
public java.util.List<TransferFile> getTransferFiles()
```
    Returns the files of the transfer, specified as List of TransferFiles.
    
    Returns:
    
    The list of files of this transfer, never null.
  - setTransferFiles
```
public void setTransferFiles(java.util.List<TransferFile> transferFiles)
```
    Sets the files of the transfer, specified as List of TransferFiles. All elements of this list are added to the file list.
    
    Parameters:
    
    transferFiles - The new list of files for this transfer.
  - addFile
```
public void addFile(TransferFile transferFile)
```
    Adds a transfer file to this transfer.
    
    Parameters:
    
    transferFile - The file to add.
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Sets the transfer password.
    
    Parameters:
    
    password - The transfer password.
  - getPassword
```
public java.lang.String getPassword()
```
    Returns the transfer password. If getPasswordMode() has been set to PasswordMode.NONE before starting a transfer, it will be set to the internal encryption password that is part of the download URLs.
    
    Returns:
    
    The transfer password.
  - getPasswordMode
```
public PasswordMode getPasswordMode()
```
    Returns the PasswordMode for the transfer.
    
    Returns:
    
    the PasswordMode.
  - setPasswordMode
```
public void setPasswordMode(PasswordMode passwordMode)
```
    Sets the PasswordMode for the transfer.
    
    Parameters:
    
    passwordMode - the PasswordMode.
  - setRecipientLanguage
```
public void setRecipientLanguage(java.util.Locale language)
```
    Sets the language used for recipient notifications.
    
    Parameters:
    
    language - The language, as Locale.
  - getRecipientLanguage
```
public java.util.Locale getRecipientLanguage()
```
    Returns the language used for recipient notifications.
    
    Returns:
    
    The language, as Locale.
  - getClassificationId
```
public java.lang.String getClassificationId()
```
    Returns the ID of the classification.
    
    Returns:
    
    The ID of the classification.
  - setClassificationId
```
public void setClassificationId(java.lang.String classificationId)
```
    Sets the ID of the classification.
    
    Parameters:
    
    classificationId - The ID of the classification.
  - getTrackingId
```
public java.lang.String getTrackingId()
```
    Returns the tracking ID, which identifies the transfer on the server. This is available after the transfer has been sent using an IClient.

Class Transfer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Transfer

Method Detail

calculateTransferSize

setExpirationDate

getExpirationDate

setSenderName

getSenderName

setSenderPhone

getSenderPhone

setMessage

setMessage

getMessage

setSubject

setSubject

getSubject

setConfidentialMessage

setConfidentialMessage

getConfidentialMessage

setConfidentialSubject

setConfidentialSubject

getConfidentialSubject

isShowFilenames

setShowFilenames

isNotifySender

setNotifySender

isNotifyRecipients

setNotifyRecipients

isInformAboutDownload

setInformAboutDownload

isSendDownloadSummary

setSendDownloadSummary

isSendMails

setSendMails

getRecipients

setRecipients

addRecipient

addRecipients

getTransferFiles

setTransferFiles

addFile

setPassword

getPassword

getPasswordMode

setPasswordMode

setRecipientLanguage

getRecipientLanguage

getClassificationId

setClassificationId

getTrackingId