From 76c92c3a018153ef33b527b75c5645973318225f Mon Sep 17 00:00:00 2001 From: vkanellopoulos Date: Tue, 7 Nov 2023 11:39:11 +0200 Subject: [PATCH] rename EudiWalletSDK to EudiWallet --- README.md | 84 +++++++++---------- .../-open-id4vp-manager/index.md | 2 +- .../add-document.md | 4 +- .../add-transfer-event-listener.md | 8 +- .../config.md | 4 +- .../create-issuance-request.md | 4 +- .../create-response.md | 2 +- .../delete-document-by-id.md | 4 +- .../document-manager.md | 4 +- .../get-document-by-id.md | 4 +- .../get-documents.md | 4 +- .../index.md | 18 ++-- .../init.md | 2 +- .../load-sample-data.md | 4 +- .../open-id4vp-manager.md | 4 +- .../remove-all-transfer-event-listeners.md | 8 +- .../remove-transfer-event-listener.md | 8 +- .../send-response.md | 2 +- .../set-reader-trust-store.md | 8 +- .../set-trusted-reader-certificates.md | 14 ++-- .../start-engagement-to-app.md | 4 +- .../start-qr-engagement.md | 4 +- .../stop-presentation.md | 2 +- .../transfer-manager.md | 4 +- .../eu.europa.ec.eudi.wallet/index.md | 2 +- docs/wallet-core/package-list | 46 +++++----- .../{EudiWalletSDK.kt => EudiWallet.kt} | 56 ++++++------- .../transfer/openid4vp/OpenId4vpManager.kt | 2 +- 28 files changed, 156 insertions(+), 156 deletions(-) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/add-document.md (82%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/add-transfer-event-listener.md (68%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/config.md (73%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/create-issuance-request.md (87%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/create-response.md (83%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/delete-document-by-id.md (79%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/document-manager.md (71%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/get-document-by-id.md (80%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/get-documents.md (77%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/index.md (84%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/init.md (89%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/load-sample-data.md (80%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/open-id4vp-manager.md (68%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/remove-all-transfer-event-listeners.md (65%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/remove-transfer-event-listener.md (66%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/send-response.md (83%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/set-reader-trust-store.md (70%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/set-trusted-reader-certificates.md (78%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/start-engagement-to-app.md (78%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/start-qr-engagement.md (73%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/stop-presentation.md (87%) rename docs/wallet-core/eu.europa.ec.eudi.wallet/{-eudi-wallet-s-d-k => -eudi-wallet}/transfer-manager.md (71%) rename wallet-core/src/main/java/eu/europa/ec/eudi/wallet/{EudiWalletSDK.kt => EudiWallet.kt} (84%) diff --git a/README.md b/README.md index 3a6ca4a7..3ea4bdea 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ The following example shows how to initialize the library: ```kotlin import eu.europa.ec.eudi.wallet.EudiWalletConfig -import eu.europa.ec.eudi.wallet.EudiWalletSDK +import eu.europa.ec.eudi.wallet.EudiWallet import java.security.cert.X509Certificate val storageDir = applicationContext.filesDir @@ -121,14 +121,14 @@ val config = EudiWalletConfig.Builder(applicationContext) .openId4VpVerifierApiUri(verifierApiUri) .build() -EudiWalletSDK.init(applicationContext, config) +EudiWallet.init(applicationContext, config) ``` To initialize the library with the default configuration, you can use the following code: ```kotlin val config = EudiWalletConfig.Builder(applicationContext).build() -EudiWalletSDK.init(applicationContext, config) +EudiWallet.init(applicationContext, config) ``` Library initialization is recommended to be done in the `Application.onCreate` method. @@ -149,38 +149,38 @@ The library provides a set of methods to work with documents. #### Listing documents -The `EudiWalletSDK.getDocuments` method that returns the list of documents stored in the library. +The `EudiWallet.getDocuments` method that returns the list of documents stored in the library. The following example shows how to list documents: ```kotlin -val documents = EudiWalletSDK.getDocuments() +val documents = EudiWallet.getDocuments() ``` #### Retrieving a document -The `EudiWalletSDK.getDocumentById` method that returns a document with the given id. +The `EudiWallet.getDocumentById` method that returns a document with the given id. The following example shows how to retrieve a document: ```kotlin -val document = EudiWalletSDK.getDocumentById(documentId) +val document = EudiWallet.getDocumentById(documentId) ``` #### Deleting a document -The `EudiWalletSDK.deleteDocumentById` method that deletes a document with the given id. +The `EudiWallet.deleteDocumentById` method that deletes a document with the given id. The following example shows how to delete a document: ```kotlin -val result = EudiWalletSDK.deleteDocumentById(documentId) +val result = EudiWallet.deleteDocumentById(documentId) when (result) { - is EudiWalletSDK.DeleteDocumentResult.Success -> { + is EudiWallet.DeleteDocumentResult.Success -> { // document deleted } - is EudiWalletSDK.DeleteDocumentResult.Failure -> { + is EudiWallet.DeleteDocumentResult.Failure -> { // error val cause = result.throwable } @@ -190,11 +190,11 @@ when (result) { #### Issuing/Adding a document Adding a document is a two step process. First, you need to create an issuanceRequest using the -method `EudiWalletSDK.createIssuanceRequest`. The issuanceRequest holds the public certificate +method `EudiWallet.createIssuanceRequest`. The issuanceRequest holds the public certificate that will be used from the issuer to sign the document. Later, when document's data is available, you can create the document using the -method `EudiWalletSDK.addDocument` to add the document to document storage. +method `EudiWallet.addDocument` to add the document to document storage. The following example shows how to add a document: @@ -206,7 +206,7 @@ val attestationChallenge = byteArrayOf( // provided by the issuer ) val requestResult = - EudiWalletSDK.createIssuanceRequest(docType, hardwareBacked, attestationChallenge) + EudiWallet.createIssuanceRequest(docType, hardwareBacked, attestationChallenge) when (requestResult) { is CreateIssuanceRequestResult.Failure -> { val error = requestResult.throwable @@ -223,7 +223,7 @@ when (requestResult) { val issuerData: ByteArray = byteArrayOf() // CBOR bytes received from issuer - val addResult = EudiWalletSDK.addDocument(request, issuerData) + val addResult = EudiWallet.addDocument(request, issuerData) when (addResult) { is AddDocumentResult.Failure -> { @@ -272,7 +272,7 @@ Currently, only one document can be added at a time. #### Loading sample documents -The library provides the `EudiWalletSDK.loadSampleData` method that allows to load sample documents +The library provides the `EudiWallet.loadSampleData` method that allows to load sample documents in document storage, without the need to issue them. The signing of the documents is done by the library internally, using a predefined key pair. @@ -282,7 +282,7 @@ The following example shows how to load sample documents: ```kotlin val sampleData = byteArrayOf() // CBOR bytes with sample documents -val result = EudiWalletSDK.loadSampleData(sampleData) +val result = EudiWallet.loadSampleData(sampleData) when (result) { is LoadSampleResult.Success -> { @@ -345,10 +345,10 @@ state of the transfer. The following events are emitted: #### Attaching a TransferEvent.Listener -To receive events from the `EudiWalletSDK`, you must attach a `TransferEvent.Listener` to it: +To receive events from the `EudiWallet`, you must attach a `TransferEvent.Listener` to it: The following example demonstrates how to implement a `TransferEvent.Listener` and attach it to the -`EudiWalletSDK` object. +`EudiWallet` object. ```kotlin @@ -377,7 +377,7 @@ val transferEventListener = TransferEvent.Listener { event -> } is ResponseResult.Response -> { val responseBytes = responseResult.bytes - EudiWalletSDK.sendResponse(responseBytes) + EudiWallet.sendResponse(responseBytes) } is ResponseResult.UserAuthRequired -> { // user authentication is required. Get the crypto object from responseResult.cryptoObject @@ -393,30 +393,30 @@ val transferEventListener = TransferEvent.Listener { event -> is TransferEvent.Disconnected -> { // event when the devices are disconnected // presentation can be stopped here - EudiWalletSDK.stopPresentation() + EudiWallet.stopPresentation() } is TransferEvent.Error -> { // event when an error occurs. Get the error from event.error val error: Throwable = event.error // handle error // stop presentation - EudiWalletSDK.stopPresentation() + EudiWallet.stopPresentation() } } } -EudiWalletSDK.addTransferEventListener(transferEventListener) +EudiWallet.addTransferEventListener(transferEventListener) ``` #### Initiating transfer 1. BLE transfer using QR Engagement - Once the a transfer event listener is attached, use the `EudiWalletSDK.startQrEngagement()` + Once the a transfer event listener is attached, use the `EudiWallet.startQrEngagement()` method to start the QR code engagement. ```kotlin - EudiWalletSDK.startQrEngagement() + EudiWallet.startQrEngagement() //... other code @@ -522,11 +522,11 @@ EudiWalletSDK.addTransferEventListener(transferEventListener) and set `launchMode="singleTask"` for this activity. To initiate the transfer using an app link (reverse engagement), use - the `EudiWalletSDK.startEngagementToApp(Intent)` method. + the `EudiWallet.startEngagementToApp(Intent)` method. The method receives as a parameter an `Intent` that contains the data for the device engagement. - The example below demonstrates how to use the `EudiWalletSDK.startEngagementToApp(Intent)` method + The example below demonstrates how to use the `EudiWallet.startEngagementToApp(Intent)` method to initiate the device engagement and transfer. ```kotlin @@ -536,12 +536,12 @@ EudiWalletSDK.addTransferEventListener(transferEventListener) override fun onResume() { super.onResume() - EudiWalletSDK.startEngagementToApp(intent) + EudiWallet.startEngagementToApp(intent) } override fun onNewIntent(intent: Intent) { super.onNewIntent(intent) - EudiWalletSDK.startEngagementToApp(intent) + EudiWallet.startEngagementToApp(intent) } } ``` @@ -566,7 +566,7 @@ EudiWalletSDK.addTransferEventListener(transferEventListener) Also set `launchMode="singleTask"` for this activity. - Then your MainActivity use the `EudiWalletSDK.openId4vpManager` property to get + Then your MainActivity use the `EudiWallet.openId4vpManager` property to get the `OpenId4VpManager` object and use it to initiate the transfer, as shown in the example below: @@ -578,7 +578,7 @@ EudiWalletSDK.addTransferEventListener(transferEventListener) import eu.europa.ec.eudi.iso18013.transfer.DisclosedDocuments import eu.europa.ec.eudi.iso18013.transfer.ResponseResult import eu.europa.ec.eudi.iso18013.transfer.TransferEvent - import eu.europa.ec.eudi.wallet.EudiWalletSDK + import eu.europa.ec.eudi.wallet.EudiWallet class MainActivity : AppCompatActivity() { @@ -590,11 +590,11 @@ EudiWalletSDK.addTransferEventListener(transferEventListener) // get disclosed documents from user ) ) - val result = EudiWalletSDK.createResponse(disclosedDocuments) + val result = EudiWallet.createResponse(disclosedDocuments) when (result) { is ResponseResult.Response -> { - EudiWalletSDK.openId4vpManager.sendResponse(result.bytes) - EudiWalletSDK.openId4vpManager.close() + EudiWallet.openId4vpManager.sendResponse(result.bytes) + EudiWallet.openId4vpManager.close() } is ResponseResult.UserAuthRequired -> { // perform user authentication @@ -606,7 +606,7 @@ EudiWalletSDK.addTransferEventListener(transferEventListener) // handle failure // close connection - EudiWalletSDK.openId4vpManager.close() + EudiWallet.openId4vpManager.close() } } @@ -621,7 +621,7 @@ EudiWalletSDK.addTransferEventListener(transferEventListener) override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) - EudiWalletSDK.openId4vpManager.addTransferEventListener(transferEventListener) + EudiWallet.openId4vpManager.addTransferEventListener(transferEventListener) } override fun onResume() { @@ -637,7 +637,7 @@ EudiWalletSDK.addTransferEventListener(transferEventListener) private fun handleOpenId4VpIntent(intent: Intent) { when (intent.scheme) { - "mdoc-openid4vp" -> EudiWalletSDK.openId4vpManager.resolveRequestUri(intent.toUri(0)) + "mdoc-openid4vp" -> EudiWallet.openId4vpManager.resolveRequestUri(intent.toUri(0)) else -> { // do nothing } @@ -656,7 +656,7 @@ documents are requested. Also, a selectively disclosure option can be implemente requested documents, so user can choose which of the documents to share. Then, a `DisclosedDocuments` object must be created with the list of documents to be disclosed and -hhe response can be created using the `EudiWalletSDK.createResponse(DisclosedDocuments)` method. +hhe response can be created using the `EudiWallet.createResponse(DisclosedDocuments)` method. The method returns a `ResponseResult` object, which can be one of the following: @@ -666,11 +666,11 @@ The method returns a `ResponseResult` object, which can be one of the following: retrieved from `responseResult.bytes`. 3. `ResponseResult.UserAuthRequired`: The response creation requires user authentication. The `CryptoObject` can be retrieved from `responseResult.cryptoObject`. After success authentication - the response can be created again, using the `EudiWalletSDK.createResponse(DisclosedDocuments)` + the response can be created again, using the `EudiWallet.createResponse(DisclosedDocuments)` method. Finally, when `createResponse(DisclosedDocuments)` returns a `ResponseResult.Response`, the response -can be sent using the `EudiWalletSDK.sendResponse(ByteArray)` method, by getting the response +can be sent using the `EudiWallet.sendResponse(ByteArray)` method, by getting the response bytes from `responseResult.bytes`. The following example demonstrates the above steps: @@ -689,13 +689,13 @@ val transferEventListener = TransferEvent.Listener { event -> // add the disclosed documents here ) ) - when (val responseResult = EudiWalletSDK.createResponse(disclosedDocuments)) { + when (val responseResult = EudiWallet.createResponse(disclosedDocuments)) { is ResponseResult.Failure -> { // handle the failure } is ResponseResult.Response -> { val responseBytes = responseResult.bytes - EudiWalletSDK.sendResponse(responseBytes) + EudiWallet.sendResponse(responseBytes) } is ResponseResult.UserAuthRequired -> { // user authentication is required. Get the crypto object from responseResult.cryptoObject diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet.transfer.openid4vp/-open-id4vp-manager/index.md b/docs/wallet-core/eu.europa.ec.eudi.wallet.transfer.openid4vp/-open-id4vp-manager/index.md index c14ed299..aea0e6c5 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet.transfer.openid4vp/-open-id4vp-manager/index.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet.transfer.openid4vp/-open-id4vp-manager/index.md @@ -24,7 +24,7 @@ val transferEventListener = TransferEvent.Listener { event -> val request = openId4vpManager.resolveRequestUri(event.request) // handle request and demand from user the documents to be disclosed val disclosedDocuments = listOf() - val response = EudiWalletSDK.createResponse(disclosedDocuments) + val response = EudiWallet.createResponse(disclosedDocuments) openId4vpManager.sendResponse(response) } } diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/add-document.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/add-document.md similarity index 82% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/add-document.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/add-document.md index 068340f1..da717a50 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/add-document.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/add-document.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[addDocument](add-document.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[addDocument](add-document.md) # addDocument @@ -30,4 +30,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/add-transfer-event-listener.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/add-transfer-event-listener.md similarity index 68% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/add-transfer-event-listener.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/add-transfer-event-listener.md index 878bc84f..8d619583 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/add-transfer-event-listener.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/add-transfer-event-listener.md @@ -1,15 +1,15 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[addTransferEventListener](add-transfer-event-listener.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[addTransferEventListener](add-transfer-event-listener.md) # addTransferEventListener [androidJvm]\ -fun [addTransferEventListener](add-transfer-event-listener.md)(listener: TransferEvent.Listener): [EudiWalletSDK](index.md) +fun [addTransferEventListener](add-transfer-event-listener.md)(listener: TransferEvent.Listener): [EudiWallet](index.md) Adds a transfer event listener in order to be notified about transfer events #### Return -[EudiWalletSDK](index.md) +[EudiWallet](index.md) #### Parameters @@ -30,4 +30,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/config.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/config.md similarity index 73% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/config.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/config.md index ae74bc7a..9b337ed6 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/config.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/config.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[config](config.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[config](config.md) # config @@ -11,4 +11,4 @@ The Config that used to initialize the sdk | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/create-issuance-request.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/create-issuance-request.md similarity index 87% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/create-issuance-request.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/create-issuance-request.md index c7eb4d83..3d1f85a9 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/create-issuance-request.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/create-issuance-request.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[createIssuanceRequest](create-issuance-request.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[createIssuanceRequest](create-issuance-request.md) # createIssuanceRequest @@ -31,4 +31,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/create-response.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/create-response.md similarity index 83% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/create-response.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/create-response.md index 88a96997..8fe23987 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/create-response.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/create-response.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[createResponse](create-response.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[createResponse](create-response.md) # createResponse diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/delete-document-by-id.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/delete-document-by-id.md similarity index 79% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/delete-document-by-id.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/delete-document-by-id.md index b1e3f859..eb0e7122 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/delete-document-by-id.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/delete-document-by-id.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[deleteDocumentById](delete-document-by-id.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[deleteDocumentById](delete-document-by-id.md) # deleteDocumentById @@ -29,4 +29,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/document-manager.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/document-manager.md similarity index 71% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/document-manager.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/document-manager.md index 277942fd..30786ec1 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/document-manager.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/document-manager.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[documentManager](document-manager.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[documentManager](document-manager.md) # documentManager @@ -17,4 +17,4 @@ Document manager | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/get-document-by-id.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/get-document-by-id.md similarity index 80% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/get-document-by-id.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/get-document-by-id.md index 942da5e0..919cbbdf 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/get-document-by-id.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/get-document-by-id.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[getDocumentById](get-document-by-id.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[getDocumentById](get-document-by-id.md) # getDocumentById @@ -29,4 +29,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/get-documents.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/get-documents.md similarity index 77% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/get-documents.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/get-documents.md index e505a28d..320bb9d3 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/get-documents.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/get-documents.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[getDocuments](get-documents.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[getDocuments](get-documents.md) # getDocuments @@ -21,4 +21,4 @@ the list of documents | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/index.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/index.md similarity index 84% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/index.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/index.md index 08032161..0358cd52 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/index.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/index.md @@ -1,8 +1,8 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md) -# EudiWalletSDK +# EudiWallet -object [EudiWalletSDK](index.md) +object [EudiWallet](index.md) Eudi wallet sdk object to access the sdk functionalities. This object must be initialized before using the sdk. The initialization can be done in the application class. The sdk can be initialized with a [EudiWalletConfig](../-eudi-wallet-config/index.md) object. @@ -20,7 +20,7 @@ val config = EudiWalletConfig.Builder(appContext) )) .bleTransferMode(EudiWalletConfig.BLE_SERVER_PERIPHERAL_MODE) .build() -EudiWalletSDK.init(context, config) +EudiWallet.init(context, config) ``` #### See also @@ -34,7 +34,7 @@ EudiWalletSDK.init(context, config) | Name | Summary | |---|---| | [addDocument](add-document.md) | [androidJvm]
fun [addDocument](add-document.md)(request: IssuanceRequest, data: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)): AddDocumentResult
Add a document to the wallet | -| [addTransferEventListener](add-transfer-event-listener.md) | [androidJvm]
fun [addTransferEventListener](add-transfer-event-listener.md)(listener: TransferEvent.Listener): [EudiWalletSDK](index.md)
Adds a transfer event listener in order to be notified about transfer events | +| [addTransferEventListener](add-transfer-event-listener.md) | [androidJvm]
fun [addTransferEventListener](add-transfer-event-listener.md)(listener: TransferEvent.Listener): [EudiWallet](index.md)
Adds a transfer event listener in order to be notified about transfer events | | [createIssuanceRequest](create-issuance-request.md) | [androidJvm]
fun [createIssuanceRequest](create-issuance-request.md)(docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hardwareBacked: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), attestationChallenge: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)? = null): CreateIssuanceRequestResult
Create an issuance request for the given [docType](create-issuance-request.md) | | [createResponse](create-response.md) | [androidJvm]
fun [createResponse](create-response.md)(disclosedDocuments: DisclosedDocuments): ResponseResult
Creates a response for the given [disclosedDocuments](create-response.md) that will be sent to the reader | | [deleteDocumentById](delete-document-by-id.md) | [androidJvm]
fun [deleteDocumentById](delete-document-by-id.md)(documentId: DocumentId): DeleteDocumentResult
Delete the document with the given [documentId](delete-document-by-id.md) | @@ -42,11 +42,11 @@ EudiWalletSDK.init(context, config) | [getDocuments](get-documents.md) | [androidJvm]
fun [getDocuments](get-documents.md)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<Document>
Returns the list of documents | | [init](init.md) | [androidJvm]
fun [init](init.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [EudiWalletConfig](../-eudi-wallet-config/index.md))
Initialize the sdk with the given [config](init.md) | | [loadSampleData](load-sample-data.md) | [androidJvm]
fun [loadSampleData](load-sample-data.md)(sampleData: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)): LoadSampleResult
Loads sample data into the wallet's document manager | -| [removeAllTransferEventListeners](remove-all-transfer-event-listeners.md) | [androidJvm]
fun [removeAllTransferEventListeners](remove-all-transfer-event-listeners.md)(): [EudiWalletSDK](index.md)
Removes all transfer event listeners. | -| [removeTransferEventListener](remove-transfer-event-listener.md) | [androidJvm]
fun [removeTransferEventListener](remove-transfer-event-listener.md)(listener: TransferEvent.Listener): [EudiWalletSDK](index.md)
Removes a transfer event listener. | +| [removeAllTransferEventListeners](remove-all-transfer-event-listeners.md) | [androidJvm]
fun [removeAllTransferEventListeners](remove-all-transfer-event-listeners.md)(): [EudiWallet](index.md)
Removes all transfer event listeners. | +| [removeTransferEventListener](remove-transfer-event-listener.md) | [androidJvm]
fun [removeTransferEventListener](remove-transfer-event-listener.md)(listener: TransferEvent.Listener): [EudiWallet](index.md)
Removes a transfer event listener. | | [sendResponse](send-response.md) | [androidJvm]
fun [sendResponse](send-response.md)(responseBytes: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html))
Sends the given [responseBytes](send-response.md) to the reader | -| [setReaderTrustStore](set-reader-trust-store.md) | [androidJvm]
fun [setReaderTrustStore](set-reader-trust-store.md)(readerTrustStore: ReaderTrustStore): [EudiWalletSDK](index.md)
Sets the reader trust store with the readers' certificates that are trusted by the wallet | -| [setTrustedReaderCertificates](set-trusted-reader-certificates.md) | [androidJvm]
fun [setTrustedReaderCertificates](set-trusted-reader-certificates.md)(@[RawRes](https://developer.android.com/reference/kotlin/androidx/annotation/RawRes.html)vararg rawRes: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [EudiWalletSDK](index.md)
Sets the readers' certificates from raw resources that are trusted by the wallet
[androidJvm]
fun [setTrustedReaderCertificates](set-trusted-reader-certificates.md)(trustedReaderCertificates: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[X509Certificate](https://developer.android.com/reference/kotlin/java/security/cert/X509Certificate.html)>): [EudiWalletSDK](index.md)
Sets the readers' certificates that are trusted by the wallet | +| [setReaderTrustStore](set-reader-trust-store.md) | [androidJvm]
fun [setReaderTrustStore](set-reader-trust-store.md)(readerTrustStore: ReaderTrustStore): [EudiWallet](index.md)
Sets the reader trust store with the readers' certificates that are trusted by the wallet | +| [setTrustedReaderCertificates](set-trusted-reader-certificates.md) | [androidJvm]
fun [setTrustedReaderCertificates](set-trusted-reader-certificates.md)(@[RawRes](https://developer.android.com/reference/kotlin/androidx/annotation/RawRes.html)vararg rawRes: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [EudiWallet](index.md)
Sets the readers' certificates from raw resources that are trusted by the wallet
[androidJvm]
fun [setTrustedReaderCertificates](set-trusted-reader-certificates.md)(trustedReaderCertificates: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[X509Certificate](https://developer.android.com/reference/kotlin/java/security/cert/X509Certificate.html)>): [EudiWallet](index.md)
Sets the readers' certificates that are trusted by the wallet | | [startEngagementToApp](start-engagement-to-app.md) | [androidJvm]
fun [startEngagementToApp](start-engagement-to-app.md)(intent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html))
Starts the transfer process by engaging with the reader via appLink | | [startQrEngagement](start-qr-engagement.md) | [androidJvm]
fun [startQrEngagement](start-qr-engagement.md)()
Starts the transfer process by engaging with the reader via QR code | | [stopPresentation](stop-presentation.md) | [androidJvm]
fun [stopPresentation](stop-presentation.md)(sendSessionTerminationMessage: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true, useTransportSpecificSessionTermination: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false)
Stops the transfer process | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/init.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/init.md similarity index 89% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/init.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/init.md index 87e46295..7bddff27 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/init.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/init.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[init](init.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[init](init.md) # init diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/load-sample-data.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/load-sample-data.md similarity index 80% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/load-sample-data.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/load-sample-data.md index dd89842c..41a29322 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/load-sample-data.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/load-sample-data.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[loadSampleData](load-sample-data.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[loadSampleData](load-sample-data.md) # loadSampleData @@ -29,4 +29,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/open-id4vp-manager.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/open-id4vp-manager.md similarity index 68% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/open-id4vp-manager.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/open-id4vp-manager.md index 60b1166c..d4fc23ac 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/open-id4vp-manager.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/open-id4vp-manager.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[openId4vpManager](open-id4vp-manager.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[openId4vpManager](open-id4vp-manager.md) # openId4vpManager @@ -17,4 +17,4 @@ OpenId4VP manager that can be used to verify OpenId4Vp requests | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method or if the [EudiWalletConfig.openId4VpVerifierApiUri](../-eudi-wallet-config/open-id4-vp-verifier-api-uri.md) is not set | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method or if the [EudiWalletConfig.openId4VpVerifierApiUri](../-eudi-wallet-config/open-id4-vp-verifier-api-uri.md) is not set | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/remove-all-transfer-event-listeners.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/remove-all-transfer-event-listeners.md similarity index 65% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/remove-all-transfer-event-listeners.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/remove-all-transfer-event-listeners.md index 2fb2f9e1..942d4c82 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/remove-all-transfer-event-listeners.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/remove-all-transfer-event-listeners.md @@ -1,15 +1,15 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[removeAllTransferEventListeners](remove-all-transfer-event-listeners.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[removeAllTransferEventListeners](remove-all-transfer-event-listeners.md) # removeAllTransferEventListeners [androidJvm]\ -fun [removeAllTransferEventListeners](remove-all-transfer-event-listeners.md)(): [EudiWalletSDK](index.md) +fun [removeAllTransferEventListeners](remove-all-transfer-event-listeners.md)(): [EudiWallet](index.md) Removes all transfer event listeners. #### Return -[EudiWalletSDK](index.md) +[EudiWallet](index.md) #### See also @@ -22,4 +22,4 @@ Removes all transfer event listeners. | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/remove-transfer-event-listener.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/remove-transfer-event-listener.md similarity index 66% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/remove-transfer-event-listener.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/remove-transfer-event-listener.md index 9a520477..cc5b3dba 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/remove-transfer-event-listener.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/remove-transfer-event-listener.md @@ -1,15 +1,15 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[removeTransferEventListener](remove-transfer-event-listener.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[removeTransferEventListener](remove-transfer-event-listener.md) # removeTransferEventListener [androidJvm]\ -fun [removeTransferEventListener](remove-transfer-event-listener.md)(listener: TransferEvent.Listener): [EudiWalletSDK](index.md) +fun [removeTransferEventListener](remove-transfer-event-listener.md)(listener: TransferEvent.Listener): [EudiWallet](index.md) Removes a transfer event listener. #### Return -[EudiWalletSDK](index.md) +[EudiWallet](index.md) #### Parameters @@ -30,4 +30,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/send-response.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/send-response.md similarity index 83% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/send-response.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/send-response.md index 30f38342..255fbc20 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/send-response.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/send-response.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[sendResponse](send-response.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[sendResponse](send-response.md) # sendResponse diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/set-reader-trust-store.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/set-reader-trust-store.md similarity index 70% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/set-reader-trust-store.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/set-reader-trust-store.md index 58bfa230..407bf129 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/set-reader-trust-store.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/set-reader-trust-store.md @@ -1,15 +1,15 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[setReaderTrustStore](set-reader-trust-store.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[setReaderTrustStore](set-reader-trust-store.md) # setReaderTrustStore [androidJvm]\ -fun [setReaderTrustStore](set-reader-trust-store.md)(readerTrustStore: ReaderTrustStore): [EudiWalletSDK](index.md) +fun [setReaderTrustStore](set-reader-trust-store.md)(readerTrustStore: ReaderTrustStore): [EudiWallet](index.md) Sets the reader trust store with the readers' certificates that are trusted by the wallet #### Return -[EudiWalletSDK](index.md) +[EudiWallet](index.md) #### Parameters @@ -29,4 +29,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/set-trusted-reader-certificates.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/set-trusted-reader-certificates.md similarity index 78% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/set-trusted-reader-certificates.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/set-trusted-reader-certificates.md index 4f241e08..d1c445a6 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/set-trusted-reader-certificates.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/set-trusted-reader-certificates.md @@ -1,15 +1,15 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[setTrustedReaderCertificates](set-trusted-reader-certificates.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[setTrustedReaderCertificates](set-trusted-reader-certificates.md) # setTrustedReaderCertificates [androidJvm]\ -fun [setTrustedReaderCertificates](set-trusted-reader-certificates.md)(trustedReaderCertificates: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[X509Certificate](https://developer.android.com/reference/kotlin/java/security/cert/X509Certificate.html)>): [EudiWalletSDK](index.md) +fun [setTrustedReaderCertificates](set-trusted-reader-certificates.md)(trustedReaderCertificates: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[X509Certificate](https://developer.android.com/reference/kotlin/java/security/cert/X509Certificate.html)>): [EudiWallet](index.md) Sets the readers' certificates that are trusted by the wallet #### Return -[EudiWalletSDK](index.md) +[EudiWallet](index.md) #### Parameters @@ -29,16 +29,16 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | [androidJvm]\ -fun [setTrustedReaderCertificates](set-trusted-reader-certificates.md)(@[RawRes](https://developer.android.com/reference/kotlin/androidx/annotation/RawRes.html)vararg rawRes: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [EudiWalletSDK](index.md) +fun [setTrustedReaderCertificates](set-trusted-reader-certificates.md)(@[RawRes](https://developer.android.com/reference/kotlin/androidx/annotation/RawRes.html)vararg rawRes: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [EudiWallet](index.md) Sets the readers' certificates from raw resources that are trusted by the wallet #### Return -[EudiWalletSDK](index.md) +[EudiWallet](index.md) #### Parameters @@ -58,4 +58,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/start-engagement-to-app.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/start-engagement-to-app.md similarity index 78% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/start-engagement-to-app.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/start-engagement-to-app.md index a718606c..f4bfb885 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/start-engagement-to-app.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/start-engagement-to-app.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[startEngagementToApp](start-engagement-to-app.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[startEngagementToApp](start-engagement-to-app.md) # startEngagementToApp @@ -25,4 +25,4 @@ androidJvm | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/start-qr-engagement.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/start-qr-engagement.md similarity index 73% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/start-qr-engagement.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/start-qr-engagement.md index 72306e3b..91023881 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/start-qr-engagement.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/start-qr-engagement.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[startQrEngagement](start-qr-engagement.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[startQrEngagement](start-qr-engagement.md) # startQrEngagement @@ -17,4 +17,4 @@ Starts the transfer process by engaging with the reader via QR code | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/stop-presentation.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/stop-presentation.md similarity index 87% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/stop-presentation.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/stop-presentation.md index 674f3c5e..a3fc6978 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/stop-presentation.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/stop-presentation.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[stopPresentation](stop-presentation.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[stopPresentation](stop-presentation.md) # stopPresentation diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/transfer-manager.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/transfer-manager.md similarity index 71% rename from docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/transfer-manager.md rename to docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/transfer-manager.md index b70d6348..f47f4f6c 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/transfer-manager.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/transfer-manager.md @@ -1,4 +1,4 @@ -//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWalletSDK](index.md)/[transferManager](transfer-manager.md) +//[wallet-core](../../../index.md)/[eu.europa.ec.eudi.wallet](../index.md)/[EudiWallet](index.md)/[transferManager](transfer-manager.md) # transferManager @@ -17,4 +17,4 @@ Transfer manager | | | |---|---| -| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWalletSDK](index.md) is not firstly initialized via the [init](init.md) method | +| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if [EudiWallet](index.md) is not firstly initialized via the [init](init.md) method | diff --git a/docs/wallet-core/eu.europa.ec.eudi.wallet/index.md b/docs/wallet-core/eu.europa.ec.eudi.wallet/index.md index 5ecb1b09..5524799e 100644 --- a/docs/wallet-core/eu.europa.ec.eudi.wallet/index.md +++ b/docs/wallet-core/eu.europa.ec.eudi.wallet/index.md @@ -6,5 +6,5 @@ | Name | Summary | |---|---| +| [EudiWallet](-eudi-wallet/index.md) | [androidJvm]
object [EudiWallet](-eudi-wallet/index.md)
Eudi wallet sdk object to access the sdk functionalities. This object must be initialized before using the sdk. The initialization can be done in the application class. The sdk can be initialized with a [EudiWalletConfig](-eudi-wallet-config/index.md) object. | | [EudiWalletConfig](-eudi-wallet-config/index.md) | [androidJvm]
class [EudiWalletConfig](-eudi-wallet-config/index.md)
Eudi wallet config. | -| [EudiWalletSDK](-eudi-wallet-s-d-k/index.md) | [androidJvm]
object [EudiWalletSDK](-eudi-wallet-s-d-k/index.md)
Eudi wallet sdk object to access the sdk functionalities. This object must be initialized before using the sdk. The initialization can be done in the application class. The sdk can be initialized with a [EudiWalletConfig](-eudi-wallet-config/index.md) object. | diff --git a/docs/wallet-core/package-list b/docs/wallet-core/package-list index 71472d9d..e1562fdd 100644 --- a/docs/wallet-core/package-list +++ b/docs/wallet-core/package-list @@ -22,6 +22,29 @@ $dokka.location:eu.europa.ec.eudi.wallet.util/CBOR/cborDecodeByteString/#kotlin. $dokka.location:eu.europa.ec.eudi.wallet.util/CBOR/cborEncode/#co.nstant.in.cbor.model.DataItem/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet.util/-c-b-o-r/cbor-encode.md $dokka.location:eu.europa.ec.eudi.wallet.util/CBOR/cborPrettyPrint/#kotlin.ByteArray/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet.util/-c-b-o-r/cbor-pretty-print.md $dokka.location:eu.europa.ec.eudi.wallet////PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/index.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet///PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/index.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/addDocument/#eu.europa.ec.eudi.wallet.document.IssuanceRequest#kotlin.ByteArray/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/add-document.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/addTransferEventListener/#eu.europa.ec.eudi.iso18013.transfer.TransferEvent.Listener/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/add-transfer-event-listener.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/config/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/config.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/createIssuanceRequest/#kotlin.String#kotlin.Boolean#kotlin.ByteArray?/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/create-issuance-request.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/createResponse/#eu.europa.ec.eudi.iso18013.transfer.DisclosedDocuments/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/create-response.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/deleteDocumentById/#kotlin.String/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/delete-document-by-id.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/documentManager/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/document-manager.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/getDocumentById/#kotlin.String/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/get-document-by-id.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/getDocuments/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/get-documents.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/init/#android.content.Context#eu.europa.ec.eudi.wallet.EudiWalletConfig/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/init.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/loadSampleData/#kotlin.ByteArray/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/load-sample-data.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/openId4vpManager/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/open-id4vp-manager.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/removeAllTransferEventListeners/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/remove-all-transfer-event-listeners.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/removeTransferEventListener/#eu.europa.ec.eudi.iso18013.transfer.TransferEvent.Listener/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/remove-transfer-event-listener.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/sendResponse/#kotlin.ByteArray/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/send-response.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/setReaderTrustStore/#eu.europa.ec.eudi.iso18013.transfer.readerauth.ReaderTrustStore/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/set-reader-trust-store.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/setTrustedReaderCertificates/#kotlin.IntArray/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/set-trusted-reader-certificates.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/setTrustedReaderCertificates/#kotlin.collections.List[java.security.cert.X509Certificate]/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/set-trusted-reader-certificates.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/startEngagementToApp/#android.content.Intent/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/start-engagement-to-app.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/startQrEngagement/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/start-qr-engagement.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/stopPresentation/#kotlin.Boolean#kotlin.Boolean/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/stop-presentation.md +$dokka.location:eu.europa.ec.eudi.wallet/EudiWallet/transferManager/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet/transfer-manager.md $dokka.location:eu.europa.ec.eudi.wallet/EudiWalletConfig.BleTransferMode///PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-config/-ble-transfer-mode/index.md $dokka.location:eu.europa.ec.eudi.wallet/EudiWalletConfig.Builder///PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-config/-builder/index.md $dokka.location:eu.europa.ec.eudi.wallet/EudiWalletConfig.Builder/Builder/#android.content.Context/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-config/-builder/-builder.md @@ -51,29 +74,6 @@ $dokka.location:eu.europa.ec.eudi.wallet/EudiWalletConfig/trustedReaderCertifica $dokka.location:eu.europa.ec.eudi.wallet/EudiWalletConfig/useHardwareToStoreKeys/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-config/use-hardware-to-store-keys.md $dokka.location:eu.europa.ec.eudi.wallet/EudiWalletConfig/userAuthenticationRequired/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-config/user-authentication-required.md $dokka.location:eu.europa.ec.eudi.wallet/EudiWalletConfig/userAuthenticationTimeOut/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-config/user-authentication-time-out.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK///PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/index.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/addDocument/#eu.europa.ec.eudi.wallet.document.IssuanceRequest#kotlin.ByteArray/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/add-document.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/addTransferEventListener/#eu.europa.ec.eudi.iso18013.transfer.TransferEvent.Listener/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/add-transfer-event-listener.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/config/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/config.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/createIssuanceRequest/#kotlin.String#kotlin.Boolean#kotlin.ByteArray?/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/create-issuance-request.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/createResponse/#eu.europa.ec.eudi.iso18013.transfer.DisclosedDocuments/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/create-response.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/deleteDocumentById/#kotlin.String/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/delete-document-by-id.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/documentManager/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/document-manager.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/getDocumentById/#kotlin.String/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/get-document-by-id.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/getDocuments/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/get-documents.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/init/#android.content.Context#eu.europa.ec.eudi.wallet.EudiWalletConfig/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/init.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/loadSampleData/#kotlin.ByteArray/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/load-sample-data.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/openId4vpManager/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/open-id4vp-manager.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/removeAllTransferEventListeners/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/remove-all-transfer-event-listeners.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/removeTransferEventListener/#eu.europa.ec.eudi.iso18013.transfer.TransferEvent.Listener/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/remove-transfer-event-listener.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/sendResponse/#kotlin.ByteArray/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/send-response.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/setReaderTrustStore/#eu.europa.ec.eudi.iso18013.transfer.readerauth.ReaderTrustStore/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/set-reader-trust-store.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/setTrustedReaderCertificates/#kotlin.IntArray/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/set-trusted-reader-certificates.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/setTrustedReaderCertificates/#kotlin.collections.List[java.security.cert.X509Certificate]/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/set-trusted-reader-certificates.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/startEngagementToApp/#android.content.Intent/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/start-engagement-to-app.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/startQrEngagement/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/start-qr-engagement.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/stopPresentation/#kotlin.Boolean#kotlin.Boolean/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/stop-presentation.md -$dokka.location:eu.europa.ec.eudi.wallet/EudiWalletSDK/transferManager/#/PointingToDeclaration/wallet-core/eu.europa.ec.eudi.wallet/-eudi-wallet-s-d-k/transfer-manager.md eu.europa.ec.eudi.wallet eu.europa.ec.eudi.wallet.document eu.europa.ec.eudi.wallet.transfer.openid4vp diff --git a/wallet-core/src/main/java/eu/europa/ec/eudi/wallet/EudiWalletSDK.kt b/wallet-core/src/main/java/eu/europa/ec/eudi/wallet/EudiWallet.kt similarity index 84% rename from wallet-core/src/main/java/eu/europa/ec/eudi/wallet/EudiWalletSDK.kt rename to wallet-core/src/main/java/eu/europa/ec/eudi/wallet/EudiWallet.kt index 7d7c613d..a9e615c7 100644 --- a/wallet-core/src/main/java/eu/europa/ec/eudi/wallet/EudiWalletSDK.kt +++ b/wallet-core/src/main/java/eu/europa/ec/eudi/wallet/EudiWallet.kt @@ -60,7 +60,7 @@ import java.security.cert.X509Certificate * )) * .bleTransferMode(EudiWalletConfig.BLE_SERVER_PERIPHERAL_MODE) * .build() - * EudiWalletSDK.init(context, config) + * EudiWallet.init(context, config) * ``` * @see [EudiWalletConfig] on how to configure the sdk * @@ -68,7 +68,7 @@ import java.security.cert.X509Certificate * */ @SuppressLint("StaticFieldLeak") -object EudiWalletSDK { +object EudiWallet { @Volatile private lateinit var context: Context @@ -87,14 +87,14 @@ object EudiWalletSDK { /** * The Config that used to initialize the sdk - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ val config get() = requireInit { _config } /** * Document manager * @see [DocumentManager] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ val documentManager: SampleDocumentManager by lazy { requireInit { @@ -118,7 +118,7 @@ object EudiWalletSDK { /** * Transfer manager * @see [TransferManager] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ val transferManager: TransferManager by lazy { requireInit { @@ -137,7 +137,7 @@ object EudiWalletSDK { /** * OpenId4VP manager that can be used to verify OpenId4Vp requests * @see [OpenId4vpManager] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method * or if the [EudiWalletConfig.openId4VpVerifierApiUri] is not set */ @get:Throws(IllegalStateException::class) @@ -154,7 +154,7 @@ object EudiWalletSDK { * Returns the list of documents * @see [DocumentManager.getDocuments] * @return the list of documents - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ fun getDocuments(): List = documentManager.getDocuments() @@ -163,7 +163,7 @@ object EudiWalletSDK { * @param documentId the document's id * @see [DocumentManager.getDocumentById] * @return the document with the given [documentId] or null if not found - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ fun getDocumentById(documentId: DocumentId): Document? = documentManager.getDocumentById(documentId) @@ -173,7 +173,7 @@ object EudiWalletSDK { * @param documentId the document's id * @see [DocumentManager.deleteDocumentById] * @return [DeleteDocumentResult] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ fun deleteDocumentById(documentId: DocumentId): DeleteDocumentResult = documentManager.deleteDocumentById(documentId) @@ -186,7 +186,7 @@ object EudiWalletSDK { * attestation (optional). If not provided, the sdk will generate a random challenge * @see [DocumentManager.createIssuanceRequest] * @return [CreateIssuanceRequestResult] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ fun createIssuanceRequest( docType: String, @@ -201,7 +201,7 @@ object EudiWalletSDK { * @param data the document data provided by the issuer * @see [DocumentManager.addDocument] * @return [AddDocumentResult] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ fun addDocument(request: IssuanceRequest, data: ByteArray): AddDocumentResult = documentManager.addDocument(request, data) @@ -211,7 +211,7 @@ object EudiWalletSDK { * @param sampleData the sample data * @see [SampleDocumentManager.loadSampleData] * @return [AddDocumentResult] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ fun loadSampleData(sampleData: ByteArray): LoadSampleResult = documentManager.loadSampleData(sampleData) @@ -220,10 +220,10 @@ object EudiWalletSDK { * Sets the reader trust store with the readers' certificates that are trusted by the wallet * @param readerTrustStore the reader trust store * @see [TransferManager.setReaderTrustStore] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method - * @return [EudiWalletSDK] + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method + * @return [EudiWallet] */ - fun setReaderTrustStore(readerTrustStore: ReaderTrustStore): EudiWalletSDK { + fun setReaderTrustStore(readerTrustStore: ReaderTrustStore): EudiWallet { transferManager.setReaderTrustStore(readerTrustStore) return this } @@ -232,8 +232,8 @@ object EudiWalletSDK { * Sets the readers' certificates that are trusted by the wallet * @param trustedReaderCertificates list of trusted reader certificates * @see [TransferManager.setReaderTrustStore] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method - * @return [EudiWalletSDK] + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method + * @return [EudiWallet] */ fun setTrustedReaderCertificates(trustedReaderCertificates: List) = apply { transferManager.setReaderTrustStore(ReaderTrustStore.getDefault(trustedReaderCertificates)) @@ -243,8 +243,8 @@ object EudiWalletSDK { * Sets the readers' certificates from raw resources that are trusted by the wallet * @param rawRes list of raw resources of trusted reader certificates * @see [TransferManager.setReaderTrustStore] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method - * @return [EudiWalletSDK] + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method + * @return [EudiWallet] */ fun setTrustedReaderCertificates(@RawRes vararg rawRes: Int) = apply { setTrustedReaderCertificates(rawRes.map { context.getCertificate(it) }) @@ -255,8 +255,8 @@ object EudiWalletSDK { * @see [TransferManager.addTransferEventListener] * @see [TransferEvent.Listener] * @param listener - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method - * @return [EudiWalletSDK] + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method + * @return [EudiWallet] */ fun addTransferEventListener(listener: TransferEvent.Listener) = apply { transferManager.addTransferEventListener(listener) @@ -267,8 +267,8 @@ object EudiWalletSDK { * @see [TransferManager.removeTransferEventListener] * @see [TransferEvent.Listener] * @param listener - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method - * @return [EudiWalletSDK] + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method + * @return [EudiWallet] * */ fun removeTransferEventListener(listener: TransferEvent.Listener) = apply { @@ -279,8 +279,8 @@ object EudiWalletSDK { * Removes all transfer event listeners. * @see [TransferManager.removeTransferEventListener] * @see [TransferEvent.Listener] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method - * @return [EudiWalletSDK] + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method + * @return [EudiWallet] */ fun removeAllTransferEventListeners() = apply { transferManager.removeAllTransferEventListeners() @@ -289,7 +289,7 @@ object EudiWalletSDK { /** * Starts the transfer process by engaging with the reader via QR code * @see [TransferManager.startQrEngagement] - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ fun startQrEngagement() = transferManager.startQrEngagement() @@ -298,7 +298,7 @@ object EudiWalletSDK { * * @see [TransferManager.startEngagementToApp] * @param intent - * @throws IllegalStateException if [EudiWalletSDK] is not firstly initialized via the [init] method + * @throws IllegalStateException if [EudiWallet] is not firstly initialized via the [init] method */ fun startEngagementToApp(intent: Intent) = transferManager.startEngagementToApp(intent) @@ -334,7 +334,7 @@ object EudiWalletSDK { private fun requireInit(block: () -> T): T { if (!::context.isInitialized) { - throw IllegalStateException("EudiWalletSDK.init() must be called before using the SDK") + throw IllegalStateException("EudiWallet.init() must be called before using the SDK") } return block() } diff --git a/wallet-core/src/main/java/eu/europa/ec/eudi/wallet/transfer/openid4vp/OpenId4vpManager.kt b/wallet-core/src/main/java/eu/europa/ec/eudi/wallet/transfer/openid4vp/OpenId4vpManager.kt index ddbc5f2c..d457c3ae 100644 --- a/wallet-core/src/main/java/eu/europa/ec/eudi/wallet/transfer/openid4vp/OpenId4vpManager.kt +++ b/wallet-core/src/main/java/eu/europa/ec/eudi/wallet/transfer/openid4vp/OpenId4vpManager.kt @@ -69,7 +69,7 @@ import java.util.UUID * val request = openId4vpManager.resolveRequestUri(event.request) * // handle request and demand from user the documents to be disclosed * val disclosedDocuments = listOf() - * val response = EudiWalletSDK.createResponse(disclosedDocuments) + * val response = EudiWallet.createResponse(disclosedDocuments) * openId4vpManager.sendResponse(response) * } * }