Skip to content

Commit

Permalink
replace document with documentId in RequestedDocument and DisclosedDo…
Browse files Browse the repository at this point in the history
…cument
  • Loading branch information
vkanellopoulos committed Dec 17, 2024
1 parent 291b41f commit 2fcf705
Show file tree
Hide file tree
Showing 15 changed files with 31 additions and 62 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ androidJvm
| keyUnlockData | the key unlock data |

[androidJvm]\
constructor(document: IssuedDocument,
constructor(documentId: DocumentId,
disclosedItems: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)
<[DocItem](../-doc-item/index.md)>, keyUnlockData: KeyUnlockData? = null)

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,22 @@
# DisclosedDocument

[androidJvm]\
data class [DisclosedDocument](index.md)(val document: IssuedDocument, val
data class [DisclosedDocument](index.md)(val documentId: DocumentId, val
disclosedItems: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)
<[DocItem](../-doc-item/index.md)>, val keyUnlockData: KeyUnlockData? = null)

Represents a response that contains the document data that will be sent to an mdoc verifier

## Constructors

| | |
|---------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [DisclosedDocument](-disclosed-document.md) | [androidJvm]<br>constructor(requestedDocument: [RequestedDocument](../-requested-document/index.md), disclosedItems: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[DocItem](../-doc-item/index.md)&gt;? = null, keyUnlockData: KeyUnlockData? = null)<br>Alternative constructor that takes a [RequestedDocument](../-requested-document/index.md) and a [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html) of [DocItem](../-doc-item/index.md) to create a [DisclosedDocument](index.md)<br>constructor(document: IssuedDocument, disclosedItems: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[DocItem](../-doc-item/index.md)&gt;, keyUnlockData: KeyUnlockData? = null) |
| | |
|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [DisclosedDocument](-disclosed-document.md) | [androidJvm]<br>constructor(requestedDocument: [RequestedDocument](../-requested-document/index.md), disclosedItems: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[DocItem](../-doc-item/index.md)&gt;? = null, keyUnlockData: KeyUnlockData? = null)<br>Alternative constructor that takes a [RequestedDocument](../-requested-document/index.md) and a [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html) of [DocItem](../-doc-item/index.md) to create a [DisclosedDocument](index.md)<br>constructor(documentId: DocumentId, disclosedItems: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[DocItem](../-doc-item/index.md)&gt;, keyUnlockData: KeyUnlockData? = null) |

## Properties

| Name | Summary |
|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [disclosedItems](disclosed-items.md) | [androidJvm]<br>val [disclosedItems](disclosed-items.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[DocItem](../-doc-item/index.md)&gt;<br>a [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html) that contains the document items [DocItem](../-doc-item/index.md), i.e the namespaces and the data elements that will be sent in the device response after selective disclosure |
| [document](document.md) | [androidJvm]<br>val [document](document.md): IssuedDocument<br>the document that will be disclosed |
| [documentId](document-id.md) | [androidJvm]<br>val [documentId](document-id.md): DocumentId<br>the unique id of the document |
| [keyUnlockData](key-unlock-data.md) | [androidJvm]<br>val [keyUnlockData](key-unlock-data.md): KeyUnlockData? = null<br>the key unlock data that will be used to unlock document's key for signing the response |
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# RequestedDocument

[androidJvm]\
constructor(document: IssuedDocument,
constructor(documentId: DocumentId,
requestedItems: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)
&lt;out [DocItem](../-doc-item/index.md), [IntentToRetain](../../eu.europa.ec.eudi.iso18013.transfer/-intent-to-retain/index.md)
&gt;, readerAuth: [ReaderAuth](../-reader-auth/index.md)?)

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# RequestedDocument

[androidJvm]\
data class [RequestedDocument](index.md)(val document: IssuedDocument, val
data class [RequestedDocument](index.md)(val documentId: DocumentId, val
requestedItems: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)
&lt;out [DocItem](../-doc-item/index.md), [IntentToRetain](../../eu.europa.ec.eudi.iso18013.transfer/-intent-to-retain/index.md)
&gt;, val readerAuth: [ReaderAuth](../-reader-auth/index.md)?)
Expand All @@ -12,15 +12,14 @@ Represents a request received by a verifier and contains the requested documents

## Constructors

| | |
|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [RequestedDocument](-requested-document.md) | [androidJvm]<br>constructor(document: IssuedDocument, requestedItems: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)&lt;out [DocItem](../-doc-item/index.md), [IntentToRetain](../../eu.europa.ec.eudi.iso18013.transfer/-intent-to-retain/index.md)&gt;, readerAuth: [ReaderAuth](../-reader-auth/index.md)?) |
| | |
|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [RequestedDocument](-requested-document.md) | [androidJvm]<br>constructor(documentId: DocumentId, requestedItems: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)&lt;out [DocItem](../-doc-item/index.md), [IntentToRetain](../../eu.europa.ec.eudi.iso18013.transfer/-intent-to-retain/index.md)&gt;, readerAuth: [ReaderAuth](../-reader-auth/index.md)?) |

## Properties

| Name | Summary |
|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [document](document.md) | [androidJvm]<br>val [document](document.md): IssuedDocument<br>the requested document after resolving the request |
| [documentId](document-id.md) | [androidJvm]<br>val [documentId](document-id.md): DocumentId<br>the unique id of the document |
| [readerAuth](reader-auth.md) | [androidJvm]<br>val [readerAuth](reader-auth.md): [ReaderAuth](../-reader-auth/index.md)?<br>the result of the reader authentication |
| [requestedItems](requested-items.md) | [androidJvm]<br>val [requestedItems](requested-items.md): [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)&lt;out [DocItem](../-doc-item/index.md), [IntentToRetain](../../eu.europa.ec.eudi.iso18013.transfer/-intent-to-retain/index.md)&gt;<br>the list of requested items |
Loading

0 comments on commit 2fcf705

Please sign in to comment.