passphrase (property)

Specifies a message decryption password.

Syntax

• Objective-C
• Swift

@property (nonatomic,readwrite,assign,getter=passphrase,setter=setPassphrase:) NSString* passphrase;
- (NSString*)passphrase;
- (void)setPassphrase:(NSString*)newPassphrase;

public var passphrase: String {
  get {...}
  set {...}
}

Default Value

""

Remarks

Use this property to provide a password to decrypt the data. Whether the message can be decrypted with a password is indicated by PassphraseUsed parameter of EncryptionInfo event.

Note that this is not the same as a secret key passphrase, which should be provided via KeyPassphrase property.

If this property is left empty or the assigned passphrase is incorrect, the PassphraseNeeded event will be fired to request the correct one.