Online Help Center > SendSafely APIs

Java API Reference

com.sendsafely

Class Package

getRecipients()
Get all recipients that are currently associated with the package
Return Type: List<Recipient>
Parameters: N/A

setRecipients(Recipients)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
Recipients List

getContactGroups()
Set internally by the API.
Return Type: List<ContactGroup>
Parameters: N/A

setContactGroups(ContactGroups)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
ContactGroups List

getPackageId()
The package ID used to identify a given package
Return Type: String
Parameters: N/A

setPackageId(PackageId)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
PackageId String

getServerSecret()
Get the server secret. The server secret is unique to a package and is used as part of the encryption key.
Return Type: String
Parameters: N/A

setServerSecret(ServerSecret)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
ServerSecret String N/A

getPackageCode()
The package code is used in the link, sent out to the recipients. It will uniquely identify a package.
Return Type: String
Parameters: N/A

setPackageCode(PackageCode)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
PackageCode String

getKeyCode()
The key code is generated by the Java API when a new package is created. It must be passed into the API when a new file is uploaded and when the package is finalized. The key code is unique for every package.
Return Type: String
Parameters: N/A

setKeyCode(KeyCode)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
KeyCode String

getFiles()
Get all files that are currently associated with the package
Return Type: List<File>
Parameters: N/A

setFiles(Files)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
Files List

getApproverList()
Returns a list of all potential approvers for the package.
Return Type: List<String>
Parameters: N/A

setApproverList(ApproverList)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
ApproverList List

getNeedsApproval()
Returns true if the package needs approval, false otherwise.
Return Type: boolean
Parameters: N/A

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

getState()
Returns the current state of the package.
Return Type: PackageState
Parameters: N/A

setState(State)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
State PackageState

getStatus()
Returns the current state of the package.
Return Type: PackageStatus
Parameters: N/A

setStatus(Status)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
Status PackageStatus

getLife()
Get the number of days the final package will be available for before it expires.
Return Type: int
Parameters: N/A

setLife(Life)
Set internally by the API.
Return Type: void
Parameters:
NameTypeDescription
Life int

getRootDirectoryId()
Return Type: String
Parameters: N/A

setRootDirectoryId(RootDirectoryId)
Return Type: void
Parameters:
NameTypeDescription
RootDirectoryId String N/A

getPackageDescriptor()
Return Type: String
Parameters: N/A

setPackageDescriptor(PackageDescriptor)
Return Type: void
Parameters:
NameTypeDescription
PackageDescriptor String N/A

getIsWorkspace()
Return Type: boolean
Parameters: N/A

setIsWorkspace(IsWorkspace)
Return Type: void
Parameters:
NameTypeDescription
IsWorkspace boolean N/A

getPackageTimestamp()
Return Type: Date
Parameters: N/A

setPackageTimestamp(PackageTimestamp)
Return Type: void
Parameters:
NameTypeDescription
PackageTimestamp Date N/A

getPackageOwner()
Return Type: String
Parameters: N/A

setPackageOwner(PackageOwner)
Return Type: void
Parameters:
NameTypeDescription
PackageOwner String N/A