Online Help Center > SendSafely APIs

Java API Reference

com.sendsafely

Class Recipient

getRecipientId()
Get the unique recipient ID for the object. The recipient ID is unique for every new package. The same user will have different recipient IDs for different packages.
Return Type: String
Parameters: N/A

setRecipientId(RecipientId)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
RecipientId String

getEmail()
Get the email address for the given recipient.
Return Type: String
Parameters: N/A

setEmail(Email)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
Email String

getNeedsApproval()
Returns true if this recipient requires approval before the package can be retrieved.
Return Type: boolean
Parameters: N/A

setNeedsApproval(NeedsApproval)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
NeedsApproval boolean

getConfirmations()
Returns the list of confirmations.
Return Type: List<Confirmation>
Parameters: N/A

setConfirmations(Confirmations)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
Confirmations List

getRole()
Retrieves the role of the recipient
Return Type: String
Parameters: N/A

setRole(RoleName)
Sets the role for the recipient
Return Type: void
Parameters:
NameTypeDescription
RoleName String Name of the role for the recipient

getApprovers()
Return Type: List
Parameters: N/A

setApprovers(Approvers)
Return Type: void
Parameters:
NameTypeDescription
Approvers List N/A

getPhonenumbers()
Return Type: List
Parameters: N/A

setPhonenumbers(Phonenumbers)
Return Type: void
Parameters:
NameTypeDescription
Phonenumbers List N/A