The Windows Client API consists of the following classes. Code for these classes can be found in the Windows Client API Code Repository. Click each class name to view detailed API reference information.
-
SendSafely.ClientAPI
Main class that includes all of the methods used to interface with SendSafely
-
SendSafely.PackageInformation
Class that is used to hold all metadata associated with a package. This object is used as the return value for several API methods and is populated with package specific properties depending on the package being manipulated.
-
SendSafely.ISendSafelyProgress
Callback interface that you must implement to receive progress updates as each file is being encrypted, signed and uploaded.
-
SendSafely.Recipient
Class that is used to hold metadata associated with a recipient. This object is used as the return value when adding a package recipient and includes the unique recipient id associated with the recipient, previous SMS phone numbers provided by the user for this recipient, a flags indicating whether this recipient requires approval, and a list of package approvers (if approval is required).
-
SendSafely.File
Class that is used to hold metadata associated with a file. This object is used as the return value when adding a file and includes the unique file id associated with the file.
-
SendSafely.Confirmation
Class that is used to hold metadata associated with a confirmation. A confirmation is added to the recipient when the recipient downloads or views a resource. A resource can be either a message or a file. Once downloaded, a time stamp and the IPAddress is recorded as a confirmation object.
-
SendSafely.PhoneNumber
Class that is used to hold each phone number associated with a recipient. This object is included as a property on the recipient and includes the Country Code and Localized Phone Number.
-
SendSafely.EnterpriseInformation
Namespace that includes numerous specific exception classes thrown by the plug-in.