refactor eu.europa.eu.eudi.wallet.issue.openid4vci package;

niscy-eudiw · Jun 21, 2024 · c9b11a1 · c9b11a1
1 parent edcc6ad
commit c9b11a1
Show file tree

Hide file tree

Showing 71 changed files with 1,350 additions and 1,122 deletions.
diff --git a/...i.wallet.issue.openid4vci/-issue-event/-document-deferred/-document-deferred.md b/...i.wallet.issue.openid4vci/-issue-event/-document-deferred/-document-deferred.md
@@ -0,0 +1,8 @@
+//[wallet-core](../../../../index.md)/[eu.europa.ec.eudi.wallet.issue.openid4vci](../../index.md)/[IssueEvent](../index.md)/[DocumentDeferred](index.md)/[DocumentDeferred](-document-deferred.md)
+
+# DocumentDeferred
+
+[androidJvm]\
+constructor(documentId: DocumentId,
+name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html),
+docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
diff --git a/...opa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-deferred/doc-type.md b/...opa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-deferred/doc-type.md
@@ -0,0 +1,6 @@
+//[wallet-core](../../../../index.md)/[eu.europa.ec.eudi.wallet.issue.openid4vci](../../index.md)/[IssueEvent](../index.md)/[DocumentDeferred](index.md)/[docType](doc-type.md)
+
+# docType
+
+[androidJvm]\
+val [docType](doc-type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
diff --git a/....ec.eudi.wallet.issue.openid4vci/-issue-event/-document-deferred/document-id.md b/....ec.eudi.wallet.issue.openid4vci/-issue-event/-document-deferred/document-id.md
@@ -0,0 +1,6 @@
+//[wallet-core](../../../../index.md)/[eu.europa.ec.eudi.wallet.issue.openid4vci](../../index.md)/[IssueEvent](../index.md)/[DocumentDeferred](index.md)/[documentId](document-id.md)
+
+# documentId
+
+[androidJvm]\
+val [documentId](document-id.md): DocumentId
diff --git a/...europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-deferred/index.md b/...europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-deferred/index.md
@@ -0,0 +1,24 @@
+//[wallet-core](../../../../index.md)/[eu.europa.ec.eudi.wallet.issue.openid4vci](../../index.md)/[IssueEvent](../index.md)/[DocumentDeferred](index.md)
+
+# DocumentDeferred
+
+[androidJvm]\
+data class [DocumentDeferred](index.md)(val documentId: DocumentId, val
+name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val
+docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [IssueEvent](../index.md)
+
+Document issuance deferred.
+
+## Constructors
+
+|                                           |                                                                                                                                                                                                                                        |
+|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [DocumentDeferred](-document-deferred.md) | [androidJvm]<br>constructor(documentId: DocumentId, name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) |
+
+## Properties
+
+| Name                         | Summary                                                                                                                                           |
+|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
+| [docType](doc-type.md)       | [androidJvm]<br>val [docType](doc-type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the document type |
+| [documentId](document-id.md) | [androidJvm]<br>val [documentId](document-id.md): DocumentId<br>the id of the deferred document                                                   |
+| [name](name.md)              | [androidJvm]<br>val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the name of the document |
diff --git a/....europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-deferred/name.md b/....europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-deferred/name.md
@@ -0,0 +1,6 @@
+//[wallet-core](../../../../index.md)/[eu.europa.ec.eudi.wallet.issue.openid4vci](../../index.md)/[IssueEvent](../index.md)/[DocumentDeferred](index.md)/[name](name.md)
+
+# name
+
+[androidJvm]\
+val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
diff --git a/...u.europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-failed/cause.md b/...u.europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-failed/cause.md
@@ -3,4 +3,5 @@
 # cause
 
 [androidJvm]\
+open override
 val [cause](cause.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)
diff --git a/...u.europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-failed/index.md b/...u.europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-failed/index.md
@@ -6,7 +6,7 @@
 data class [DocumentFailed](index.md)(val
 name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val
 docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val
-cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) : [IssueEvent](../index.md)
+cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) : [IssueEvent](../index.md), [OpenId4VciResult.Erroneous](../../-open-id4-vci-result/-erroneous/index.md)
 
 Document issuance failed.
 
@@ -16,16 +16,10 @@ Document issuance failed.
 |---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | [DocumentFailed](-document-failed.md) | [androidJvm]<br>constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) |
 
-## Functions
-
-| Name                     | Summary                                                                                                                                        |
-|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
-| [toString](to-string.md) | [androidJvm]<br>open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
-
 ## Properties
 
-| Name                   | Summary                                                                                                                                                            |
-|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [cause](cause.md)      | [androidJvm]<br>val [cause](cause.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)<br>the error that caused the failure |
-| [docType](doc-type.md) | [androidJvm]<br>val [docType](doc-type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the document type                  |
-| [name](name.md)        | [androidJvm]<br>val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the name of the document                  |
+| Name                   | Summary                                                                                                                                                                          |
+|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [cause](cause.md)      | [androidJvm]<br>open override val [cause](cause.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)<br>the error that caused the failure |
+| [docType](doc-type.md) | [androidJvm]<br>val [docType](doc-type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the document type                                |
+| [name](name.md)        | [androidJvm]<br>val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the name of the document                                |
diff --git a/...ropa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-failed/to-string.md b/...ropa.ec.eudi.wallet.issue.openid4vci/-issue-event/-document-failed/to-string.md
diff --git a/...d4vci/-issue-event/-document-requires-user-auth/-document-requires-user-auth.md b/...d4vci/-issue-event/-document-requires-user-auth/-document-requires-user-auth.md
@@ -5,4 +5,6 @@
 [androidJvm]\
 constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html),
 docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html),
-cryptoObject: [BiometricPrompt.CryptoObject](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.CryptoObject.html)?)
+cryptoObject: [BiometricPrompt.CryptoObject](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.CryptoObject.html)?,
+resume: () -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), cancel: ()
+-&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
diff --git a/...udi.wallet.issue.openid4vci/-issue-event/-document-requires-user-auth/cancel.md b/...udi.wallet.issue.openid4vci/-issue-event/-document-requires-user-auth/cancel.md
@@ -3,4 +3,4 @@
 # cancel
 
 [androidJvm]\
-abstract fun [cancel](cancel.md)()
+val [cancel](cancel.md): () -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
diff --git a/...eudi.wallet.issue.openid4vci/-issue-event/-document-requires-user-auth/index.md b/...eudi.wallet.issue.openid4vci/-issue-event/-document-requires-user-auth/index.md
@@ -3,31 +3,27 @@
 # DocumentRequiresUserAuth
 
 [androidJvm]\
-abstract class [DocumentRequiresUserAuth](index.md)(val
+data class [DocumentRequiresUserAuth](index.md)(val
 name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val
 docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val
-cryptoObject: [BiometricPrompt.CryptoObject](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.CryptoObject.html)?) : [IssueEvent](../index.md)
+cryptoObject: [BiometricPrompt.CryptoObject](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.CryptoObject.html)?,
+val resume: () -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), val cancel: ()
+-&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) : [IssueEvent](../index.md)
 
 The document issuance requires user authentication.
 
 ## Constructors
 
-|                                                             |                                                                                                                                                                                                                                                                                                                                                                    |
-|-------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [DocumentRequiresUserAuth](-document-requires-user-auth.md) | [androidJvm]<br>constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cryptoObject: [BiometricPrompt.CryptoObject](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.CryptoObject.html)?) |
-
-## Functions
-
-| Name                     | Summary                                                                                                                                        |
-|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
-| [cancel](cancel.md)      | [androidJvm]<br>abstract fun [cancel](cancel.md)()                                                                                             |
-| [resume](resume.md)      | [androidJvm]<br>abstract fun [resume](resume.md)()                                                                                             |
-| [toString](to-string.md) | [androidJvm]<br>open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+|                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+|-------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [DocumentRequiresUserAuth](-document-requires-user-auth.md) | [androidJvm]<br>constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), docType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cryptoObject: [BiometricPrompt.CryptoObject](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.CryptoObject.html)?, resume: () -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), cancel: () -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) |
 
 ## Properties
 
 | Name                             | Summary                                                                                                                                                                                                                                   |
 |----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [cancel](cancel.md)              | [androidJvm]<br>val [cancel](cancel.md): () -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>the callback to cancel the issuance                                                                     |
 | [cryptoObject](crypto-object.md) | [androidJvm]<br>val [cryptoObject](crypto-object.md): [BiometricPrompt.CryptoObject](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt.CryptoObject.html)?<br>the crypto object to use for authentication |
-| [docType](doc-type.md)           | [androidJvm]<br>val [docType](doc-type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)                                                                                                              |
-| [name](name.md)                  | [androidJvm]<br>val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)                                                                                                                     |
+| [docType](doc-type.md)           | [androidJvm]<br>val [docType](doc-type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the document type                                                                                         |
+| [name](name.md)                  | [androidJvm]<br>val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the name of the document                                                                                         |
+| [resume](resume.md)              | [androidJvm]<br>val [resume](resume.md): () -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>the callback to resume the issuance                                                                     |
diff --git a/...udi.wallet.issue.openid4vci/-issue-event/-document-requires-user-auth/resume.md b/...udi.wallet.issue.openid4vci/-issue-event/-document-requires-user-auth/resume.md
@@ -3,4 +3,4 @@
 # resume
 
 [androidJvm]\
-abstract fun [resume](resume.md)()
+val [resume](resume.md): () -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
diff --git a/....wallet.issue.openid4vci/-issue-event/-document-requires-user-auth/to-string.md b/....wallet.issue.openid4vci/-issue-event/-document-requires-user-auth/to-string.md
diff --git a/...t-core/eu.europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-failure/cause.md b/...t-core/eu.europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-failure/cause.md
@@ -3,4 +3,5 @@
 # cause
 
 [androidJvm]\
+open override
 val [cause](cause.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)
diff --git a/...t-core/eu.europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-failure/index.md b/...t-core/eu.europa.ec.eudi.wallet.issue.openid4vci/-issue-event/-failure/index.md
@@ -4,7 +4,7 @@
 
 [androidJvm]\
 data class [Failure](index.md)(val
-cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) : [IssueEvent](../index.md)
+cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) : [IssueEvent](../index.md), [OpenId4VciResult.Erroneous](../../-open-id4-vci-result/-erroneous/index.md)
 
 The issuance failed.
 
@@ -16,6 +16,6 @@ The issuance failed.
 
 ## Properties
 
-| Name              | Summary                                                                                                                                                            |
-|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [cause](cause.md) | [androidJvm]<br>val [cause](cause.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)<br>the error that caused the failure |
+| Name              | Summary                                                                                                                                                                          |
+|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [cause](cause.md) | [androidJvm]<br>open override val [cause](cause.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)<br>the error that caused the failure |