aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Schürmann <dominik@dominikschuermann.de>2016-02-22 20:41:04 +0100
committerDominik Schürmann <dominik@dominikschuermann.de>2016-05-07 12:05:56 +0300
commite7d72da343c6a42da6d1beb98ac8014da7cbce30 (patch)
tree47e168086d1f71f487d85674808641d6d518fe17
parente0bf61df93c07bdc52d83c2f9f192d738b695ad0 (diff)
downloadopenpgp-api-e7d72da343c6a42da6d1beb98ac8014da7cbce30.tar.gz
openpgp-api-e7d72da343c6a42da6d1beb98ac8014da7cbce30.tar.bz2
openpgp-api-e7d72da343c6a42da6d1beb98ac8014da7cbce30.zip
Improve documentation
Conflicts: openpgp-api/src/main/java/org/openintents/openpgp/util/OpenPgpApi.java
-rw-r--r--openpgp-api/src/main/java/org/openintents/openpgp/OpenPgpSignatureResult.java11
-rw-r--r--openpgp-api/src/main/java/org/openintents/openpgp/util/OpenPgpApi.java23
2 files changed, 17 insertions, 17 deletions
diff --git a/openpgp-api/src/main/java/org/openintents/openpgp/OpenPgpSignatureResult.java b/openpgp-api/src/main/java/org/openintents/openpgp/OpenPgpSignatureResult.java
index f188968..ad3bb29 100644
--- a/openpgp-api/src/main/java/org/openintents/openpgp/OpenPgpSignatureResult.java
+++ b/openpgp-api/src/main/java/org/openintents/openpgp/OpenPgpSignatureResult.java
@@ -49,10 +49,11 @@ public class OpenPgpSignatureResult implements Parcelable {
public static final int RESULT_INVALID_INSECURE = 6;
int result;
- boolean signatureOnly;
String primaryUserId;
ArrayList<String> userIds;
long keyId;
+ @Deprecated
+ boolean signatureOnly;
public int getResult() {
return result;
@@ -62,16 +63,12 @@ public class OpenPgpSignatureResult implements Parcelable {
this.result = result;
}
- /**
- * @deprecated
- */
+ @Deprecated
public boolean isSignatureOnly() {
return signatureOnly;
}
- /**
- * @deprecated
- */
+ @Deprecated
public void setSignatureOnly(boolean signatureOnly) {
this.signatureOnly = signatureOnly;
}
diff --git a/openpgp-api/src/main/java/org/openintents/openpgp/util/OpenPgpApi.java b/openpgp-api/src/main/java/org/openintents/openpgp/util/OpenPgpApi.java
index c88732c..5417f6b 100644
--- a/openpgp-api/src/main/java/org/openintents/openpgp/util/OpenPgpApi.java
+++ b/openpgp-api/src/main/java/org/openintents/openpgp/util/OpenPgpApi.java
@@ -201,32 +201,35 @@ public class OpenPgpApi {
* <p/>
* optional extras:
* String EXTRA_REQUEST_ASCII_ARMOR (request that the returned key is encoded in ASCII Armor)
- *
*/
public static final String ACTION_GET_KEY = "org.openintents.openpgp.action.GET_KEY";
/**
- * Backup keys
+ * Backup all keys given by EXTRA_KEY_IDS and if requested their secret parts.
+ * The encrypted backup will be written to the OutputStream.
+ * The client app has no access to the backup code used to encrypt the backup!
+ * This operation always requires user interaction with RESULT_CODE_USER_INTERACTION_REQUIRED!
* <p/>
* required extras:
- * long[] EXTRA_KEY_IDS
- * boolean EXTRA_BACKUP_SECRET
- *
+ * long[] EXTRA_KEY_IDS (keys that should be included in the backup)
+ * boolean EXTRA_BACKUP_SECRET (also backup secret keys)
*/
public static final String ACTION_BACKUP = "org.openintents.openpgp.action.BACKUP";
/**
- * Restore keys
+ * Restore keys given a backup as InputStream.
+ * This operation always requires user interaction with RESULT_CODE_USER_INTERACTION_REQUIRED!
*
+ * NOT IMPLEMENTED RIGHT NOW!
*/
- public static final String ACTION_RESTORE = "org.openintents.openpgp.action.RESTORE";
+ private static final String ACTION_RESTORE = "org.openintents.openpgp.action.RESTORE";
/**
- * Import keys from input stream. Will return RESULT_CODE_USER_INTERACTION_REQUIRED to let the
- * user acknowledge the import.
+ * Import keys from InputStream. Only public keys will be imported!
*
+ * NOT IMPLEMENTED RIGHT NOW!
*/
- public static final String ACTION_IMPORT_KEY = "org.openintents.openpgp.action.IMPORT_KEYS";
+ private static final String ACTION_IMPORT_KEY = "org.openintents.openpgp.action.IMPORT_KEYS";
/* Intent extras */