Updated Documentation and New Features for v3 Release

 Updated Documentation and New Features for v3 Release

Author: SendSafely-GitHub

SendSafelyAPI/lib/commons-io-2.5.jar

@@ -31,6 +31,7 @@ public class BasePackage {
 	private String packageOwner = "";
 
 	/**
+	 * @returnType String
 	 * @description The package ID used to identify a given package
 	 * @return The package ID
 	 */
@@ -47,6 +48,7 @@ public void setPackageId(String packageId) {
 	}
 
 	/**
+	 * @returnType String
 	 * @description Get the server secret. The server secret is unique to a package and is used as part of the encryption key.
 	 * @return The server secret
 	 */
@@ -63,6 +65,7 @@ public void setServerSecret(String serverSecret) {
 	}
 
 	/**
+	 * @returnType String
 	 * @description The package code is used in the link, sent out to the recipients. It will uniquely identify a package.
 	 * @return the package code
 	 */
@@ -79,6 +82,7 @@ public void setPackageCode(String packageCode) {
 	}
 
 	/**
+	 * @returnType String
 	 * @description 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
 	 */
@@ -96,8 +100,8 @@ public void setKeyCode(String keyCode) {
 
 	/**
 	 * @description Get all files that are currently associated with the package
-	 * @returnType File
-	 * @return
+	 * @returnType List<File>
+	 * @return A list of Files. 
 	 */
 	public List<File> getFiles() {
 		return files;
@@ -113,7 +117,8 @@ public void setFiles(List<File> files) {
 
 	/**
 	 * @description Returns a list of all potential approvers for the package.
-	 * @return
+	 * @returnType List<String>
+	 * @return A list of string type approvers.
 	 */
 	public List<String> getApproverList() {
 		return approverList;
@@ -129,7 +134,8 @@ public void setApproverList(List<String> approverList) {
 
 	/**
 	 * @description Returns true if the package needs approval, false otherwise.
-	 * @return
+	 * @returnType boolean
+	 * @return A boolean representing that the package needs approval. 
 	 */
 	public boolean getNeedsApproval() {
 		return needsApproval;
@@ -145,7 +151,8 @@ public void setNeedsApproval(boolean needsApproval) {
 
 	/** 
 	 * @description Returns the current state of the package. 
-	 * @return
+	 * @returnType PackageState
+	 * @return The package state.
 	 */
 	public PackageState getState() {
 		return state;
@@ -161,7 +168,8 @@ public void setState(PackageState state) {
 
 	/** 
 	 * @description Returns the current state of the package. 
-	 * @return
+	 * @returnType PackageStatus
+	 * @return The package status.
 	 */
 	public PackageStatus getStatus() {
 		return status;
@@ -177,7 +185,8 @@ public void setStatus(PackageStatus status) {
 
 	/**
 	 * @description Get the number of days the final package will be available for before it expires.
-	 * @return
+	 * @returnType int
+	 * @return the int representing the package life.
 	 */
 	public int getLife() {
 		return life;
@@ -191,6 +200,10 @@ public void setLife(int life) {
 		this.life = life;
 	}
 
+	/**
+	 * @returnType String
+	 * @return
+	 */
 	public String getRootDirectoryId() {
 		return rootDirectoryId;
 	}
@@ -199,6 +212,10 @@ public void setRootDirectoryId(String rootDirectoryId) {
 		this.rootDirectoryId = rootDirectoryId;
 	}
 
+	/**
+	 * @returnType String
+	 * @return
+	 */
 	public String getPackageDescriptor() {
 		return packageDescriptor;
 	}
@@ -207,6 +224,10 @@ public void setPackageDescriptor(String packageDescriptor) {
 		this.packageDescriptor = packageDescriptor;
 	}
 
+	/**
+	 * @returnType boolean
+	 * @return
+	 */
 	public boolean getIsWorkspace() {
 		return isWorkspace;
 	}
@@ -215,6 +236,10 @@ public void setIsWorkspace(boolean isWorkspace) {
 		this.isWorkspace = isWorkspace;
 	}
 
+	/**
+	 * @returnType Date
+	 * @return
+	 */
 	public Date getPackageTimestamp() {
 		return packageTimestamp;
 	}
@@ -223,6 +248,10 @@ public void setPackageTimestamp(Date packageTimestamp) {
 		this.packageTimestamp = packageTimestamp;
 	}
 
+	/**
+	 * @returnType String
+	 * @return
+	 */
 	public String getPackageOwner() {
 		return packageOwner;
 	}

SendSafelyAPI/src/com/sendsafely/BasePackage.java

@@ -21,6 +21,7 @@ public class ContactGroup {
 
 	/**
 	 * @description Get the contact group id
+	 * @returnType String
 	 * @return contactGroupId The id representation of the contact group.
 	 */
 	public String getContactGroupId() {
@@ -37,7 +38,8 @@ public void setContactGroupId(String contactGroupId) {
 
 	/**
 	 * @description Get the contact group Name
-	 * @return contactGroupName
+	 * @returnType String
+	 * @return A string of contactGroupName
 	 */
 	public String getContactGroupName() {
 		return contactGroupName;
@@ -53,7 +55,8 @@ public void setContactGroupName(String contactGroupName) {
 
 	/**
 	 * @description Get a list of users
-	 * @return List<Map<String,String>> users
+	 * @returnType List<ContactGroupMember>
+	 * @return A list of ContactGrouMember.
 	 */
 	public List<ContactGroupMember> getContactGroupMembers() {
 		return users;
@@ -69,6 +72,7 @@ public void setContactGroupMembers(List<ContactGroupMember> users) {
 
 	/**
 	 * @description Gets the status of if it's an enterprise contact group.
+	 * @returnType boolean
 	 * @return is enterprise contact group
 	 */
 	public boolean getContactGroupIsOrganizationGroup() {
@@ -79,8 +83,6 @@ public boolean getContactGroupIsOrganizationGroup() {
 	 * Sets the value for if the group is an enterprise contact group.
 	 * @param contactGroupIsOrganizationGroup
 	 */
-	
-
 	public void setContactGroupIsOrganizationGroup(boolean contactGroupIsOrganizationGroup) {
 		this.contactGroupIsOrganizationGroup = contactGroupIsOrganizationGroup;
 	}

SendSafelyAPI/src/com/sendsafely/ContactGroup.java

@@ -18,6 +18,10 @@ public Directory(String directoryId, String directoryName){
 		this.directoryId = directoryId;
 	}
 
+	/**
+	 * @returnType String
+	 * @return
+	 */
 	public String getDirectoryId() {
 		return directoryId;
 	}
@@ -26,6 +30,10 @@ public void setDirectoryId(String directoryId) {
 		this.directoryId = directoryId;
 	}
 
+	/**
+	 * @returnType Directory
+	 * @return
+	 */
 	public Directory getDirectory() {
 		return directory;
 	}
@@ -34,6 +42,10 @@ public void setDirectory(Directory directory) {
 		this.directory = directory;
 	}
 
+	/**
+	 * @returnType String
+	 * @return
+	 */
 	public String getDirectoryName() {
 		return directoryName;
 	}
@@ -42,6 +54,10 @@ public void setDirectoryName(String directoryName) {
 		this.directoryName = directoryName;
 	}
 
+	/**
+	 * @returnType List<File>
+	 * @return
+	 */
 	public List<File> getFiles() {
 		return files;
 	}
@@ -50,6 +66,10 @@ public void setFiles(List<File> files) {
 		this.files = files;
 	}
 
+	/**
+	 * @returnType Collection<Subdirectory>
+	 * @return
+	 */
 	public Collection<Subdirectory> getSubDirectories() {
 		return subDirectories;
 	}

SendSafelyAPI/src/com/sendsafely/Directory.java

@@ -27,7 +27,8 @@ public File() {
 
 	/**
 	 * @description Get the unique file ID associated with the file.
-	 * @return
+	 * @returnType String
+	 * @return A string representing File Id.
 	 */
 	public String getFileId() {
 		return fileId;
@@ -43,7 +44,8 @@ public void setFileId(String fileId) {
 
 	/**
 	 * @description Get the filename associated with the file.
-	 * @return
+	 * @returnType String
+	 * @return A string representing File Name.
 	 */
 	public String getFileName() {
 		return fileName;
@@ -59,7 +61,8 @@ public void setFileName(String fileName) {
 
 	/**
 	 * @description Get the file size for the unencrypted file.
-	 * @return
+	 * @returnType long
+	 * @return A long representing File Size.
 	 */
 	public long getFileSize() {
 		return fileSize;

SendSafelyAPI/src/com/sendsafely/File.java

@@ -15,8 +15,8 @@ public class Package extends BasePackage {
 	private List<ContactGroup> contactGroups;
 	/**
 	 * @description Get all recipients that are currently associated with the package
-	 * @returnType Recipient
-	 * @return
+	 * @returnType List<Recipient>
+	 * @return A list of recipients.
 	 */
 	public List<Recipient> getRecipients() {
 		return recipients;
@@ -32,7 +32,8 @@ public void setRecipients(List<Recipient> recipients) {
 
 	/**
 	 * @description Set internally by the API.
-	 * @return
+	 * @returnType List<ContactGroup>
+	 * @return A list of contact groups.
 	 */
 	public List<ContactGroup> getContactGroups() {
 		return contactGroups;

SendSafelyAPI/src/com/sendsafely/Package.java

@@ -15,8 +15,8 @@ public class PackageReference extends BasePackage {
 
 	/**
 	 * @description Get all recipients that are currently associated with the package
-	 * @returnType Email
-	 * @return
+	 * @returnType List<String>
+	 * @return A list of recipient emails.
 	 */
 	public List<String> getRecipients() {
 		return recipients;
@@ -32,8 +32,8 @@ public void setRecipients(List<String> recipients) {
 
 	/**
 	 * @description Get all contactGroup names that are currently associated with the package
-	 * @returnType contactGroupName
-	 * @return
+	 * @returnType List<String>
+	 * @return A list of contact group names.
 	 */
 	public List<String> getContactGroupNames() {
 		return contactGroupNames;

SendSafelyAPI/src/com/sendsafely/PackageReference.java

@@ -6,12 +6,22 @@ public class PackageSearchResults {
 
 	List<PackageReference> packages;
 	boolean capped;
+	
+	/**
+	 * @returnType List<PackageReference>
+	 * @return
+	 */
 	public List<PackageReference> getPackages() {
 		return packages;
 	}
 	public void setPackages(List<PackageReference> packages) {
 		this.packages = packages;
 	}
+	
+	/**
+	 * @returnType boolean
+	 * @return
+	 */
 	public boolean isCapped() {
 		return capped;
 	}