EncryptionSession

class EncryptionSession(encryptionSession: MobileEncryptionSession)

An encryption session, with which you can then encrypt / decrypt multiple messages or files. This should not be instantiated directly, and should be either created with SealdSDK.createEncryptionSession, or retrieved with SealdSDK.retrieveEncryptionSession or SealdSDK.retrieveEncryptionSessionFromMessage.

Constructors

EncryptionSession	constructor(encryptionSession: MobileEncryptionSession)

Properties

Name	Summary
retrievalDetails	val retrievalDetails: EncryptionSessionRetrievalDetails Details about how this session was retrieved: through a group, a proxy, or directly. Read-only.
sessionId	val sessionId: String The ID of this encryptionSession. Read-only.

Functions

Name	Summary
addMultipleTmrAccesses	fun addMultipleTmrAccesses(recipients: Array<TmrRecipientWithRights>): Map<String, ActionStatus> Add multiple TMR accesses to this session for the given authentication factors.
addMultipleTmrAccessesAsync	suspend fun addMultipleTmrAccessesAsync(recipients: Array<TmrRecipientWithRights>): Map<String, ActionStatus> Add multiple TMR accesses to this session for the given authentication factors.
addProxySession	fun addProxySession(proxySessionId: String, rights: RecipientRights = RecipientRights()) Add a proxy session as a recipient of this session. Any recipient of the proxy session will also be able to retrieve this session. The current user has to be a direct recipient of the proxy session.
addProxySessionAsync	suspend fun addProxySessionAsync(proxySessionId: String, rights: RecipientRights = RecipientRights()) Add a proxy session as a recipient of this session. Any recipient of the proxy session will also be able to retrieve this session. The current user has to be a direct recipient of the proxy session.
addRecipients	fun addRecipients(recipients: Array<RecipientWithRights>): Map<String, ActionStatus> Add new recipients to this session. These recipients will be able to read all encrypted messages of this session.
addRecipientsAsync	suspend fun addRecipientsAsync(recipients: Array<RecipientWithRights>): Map<String, ActionStatus> Add new recipients to this session. These recipients will be able to read all encrypted messages of this session.
addTmrAccess	fun addTmrAccess(recipient: TmrRecipientWithRights): String Add a TMR access to this session for the given authentication factor.
addTmrAccessAsync	suspend fun addTmrAccessAsync(recipient: TmrRecipientWithRights): String Add a TMR access to this session for the given authentication factor.
decryptFile	fun decryptFile(encryptedFile: ByteArray): ClearFile Decrypts an encrypted file into the corresponding clear-text file.
decryptFileAsync	suspend fun decryptFileAsync(encryptedFile: ByteArray): ClearFile Decrypts an encrypted file into the corresponding clear-text file.
decryptFileFromURI	fun decryptFileFromURI(encryptedFileURI: String): String Decrypts an encrypted file into the corresponding clear-text file.
decryptFileFromURIAsync	suspend fun decryptFileFromURIAsync(encryptedFileURI: String): String Decrypts an encrypted file into the corresponding clear-text file.
decryptMessage	fun decryptMessage(encryptedMessage: String): String Decrypt an encrypted message string into the corresponding clear-text string.
decryptMessageAsync	suspend fun decryptMessageAsync(encryptedMessage: String): String Decrypt an encrypted message string into the corresponding clear-text string.
encryptFile	fun encryptFile(clearFile: ByteArray, filename: String): ByteArray Encrypt a clear-text file into an encrypted file, for the recipients of this session.
encryptFileAsync	suspend fun encryptFileAsync(clearFile: ByteArray, filename: String): ByteArray Encrypt a clear-text file into an encrypted file, for the recipients of this session.
encryptFileFromURI	fun encryptFileFromURI(clearFileURI: String): String Encrypt a clear file into an encrypted file, for the recipients of this session.
encryptFileFromURIAsync	suspend fun encryptFileFromURIAsync(clearFileURI: String): String Encrypt a clear file into an encrypted file, for the recipients of this session.
encryptMessage	fun encryptMessage(clearMessage: String): String Encrypt a clear-text string into an encrypted message, for the recipients of this session.
encryptMessageAsync	suspend fun encryptMessageAsync(clearMessage: String): String Encrypt a clear-text string into an encrypted message, for the recipients of this session.
revokeAll	fun revokeAll(): RevokeResult Revoke this session entirely.
revokeAllAsync	suspend fun revokeAllAsync(): RevokeResult Revoke this session entirely.
revokeOthers	fun revokeOthers(): RevokeResult Revoke all recipients besides yourself from this session.
revokeOthersAsync	suspend fun revokeOthersAsync(): RevokeResult Revoke all recipients besides yourself from this session.
revokeRecipients	fun revokeRecipients(recipientsIds: Array<String>, proxySessionsIds: Array<String>): RevokeResult Revoke some recipients or proxy sessions from this session. If you want to revoke all recipients, see revokeAll instead. If you want to revoke all recipients besides yourself, see revokeOthers.
revokeRecipientsAsync	suspend fun revokeRecipientsAsync(recipientsIds: Array<String>, proxySessionsIds: Array<String>): RevokeResult Revoke some recipients or proxy sessions from this session. If you want to revoke all recipients, see revokeAll instead. If you want to revoke all recipients besides yourself, see revokeOthers.