Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor/document formats #37

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[transfer-manager](../../../index.md)/[eu.europa.ec.eudi.iso18013.transfer.response.device](../index.md)/[MsoMdocItem](index.md)/[MsoMdocItem](-mso-mdoc-item.md)

# MsoMdocItem

[androidJvm]\
constructor(
namespace: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html),
elementIdentifier: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
//[transfer-manager](../../../index.md)/[eu.europa.ec.eudi.iso18013.transfer.response.device](../index.md)/[MsoMdocItem](index.md)/[elementIdentifier](element-identifier.md)

# elementIdentifier

[androidJvm]\
open override
val [elementIdentifier](element-identifier.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
//[transfer-manager](../../../index.md)/[eu.europa.ec.eudi.iso18013.transfer.response.device](../index.md)/[MsoMdocItem](index.md)

# MsoMdocItem

[androidJvm]\
data class [MsoMdocItem](index.md)(val
namespace: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val
elementIdentifier: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [DocItem](../../eu.europa.ec.eudi.iso18013.transfer.response/-doc-item/index.md)

Represents a [DocItem](../../eu.europa.ec.eudi.iso18013.transfer.response/-doc-item/index.md) for
mso_mdoc document items. Includes the namespace and element identifier of the document item.

## Constructors

| | |
|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [MsoMdocItem](-mso-mdoc-item.md) | [androidJvm]<br>constructor(namespace: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), elementIdentifier: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) |

## Properties

| Name | Summary |
|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [elementIdentifier](element-identifier.md) | [androidJvm]<br>open override val [elementIdentifier](element-identifier.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>The element identifier of the MsoMdocItem. |
| [namespace](namespace.md) | [androidJvm]<br>val [namespace](namespace.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>The namespace of the element. |
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//[transfer-manager](../../../index.md)/[eu.europa.ec.eudi.iso18013.transfer.response](../index.md)/[DocItem](index.md)/[namespace](namespace.md)
//[transfer-manager](../../../index.md)/[eu.europa.ec.eudi.iso18013.transfer.response.device](../index.md)/[MsoMdocItem](index.md)/[namespace](namespace.md)

# namespace

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@
| [DeviceRequest](-device-request/index.md) | [androidJvm]<br>data class [DeviceRequest](-device-request/index.md)(val deviceRequestBytes: [DeviceRequestBytes](../eu.europa.ec.eudi.iso18013.transfer/-device-request-bytes/index.md), val sessionTranscriptBytes: [SessionTranscriptBytes](../eu.europa.ec.eudi.iso18013.transfer/-session-transcript-bytes/index.md)) : [Request](../eu.europa.ec.eudi.iso18013.transfer.response/-request/index.md)<br>Represents a Device Request according to ISO 18013-5 standard. |
| [DeviceRequestProcessor](-device-request-processor/index.md) | [androidJvm]<br>class [DeviceRequestProcessor](-device-request-processor/index.md)(documentManager: DocumentManager, var readerTrustStore: [ReaderTrustStore](../eu.europa.ec.eudi.iso18013.transfer.readerauth/-reader-trust-store/index.md)? = null) : [RequestProcessor](../eu.europa.ec.eudi.iso18013.transfer.response/-request-processor/index.md), [ReaderTrustStoreAware](../eu.europa.ec.eudi.iso18013.transfer.readerauth/-reader-trust-store-aware/index.md)<br>Implementation of [RequestProcessor](../eu.europa.ec.eudi.iso18013.transfer.response/-request-processor/index.md) for [DeviceRequest](-device-request/index.md) for the ISO 18013-5 standard. |
| [DeviceResponse](-device-response/index.md) | [androidJvm]<br>data class [DeviceResponse](-device-response/index.md)(val deviceResponseBytes: [DeviceResponseBytes](../eu.europa.ec.eudi.iso18013.transfer/-device-response-bytes/index.md)) : [Response](../eu.europa.ec.eudi.iso18013.transfer.response/-response/index.md)<br>Represents a Device Response according to ISO 18013-5 standard. |
| [MsoMdocItem](-mso-mdoc-item/index.md) | [androidJvm]<br>data class [MsoMdocItem](-mso-mdoc-item/index.md)(val namespace: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val elementIdentifier: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [DocItem](../eu.europa.ec.eudi.iso18013.transfer.response/-doc-item/index.md)<br>Represents a [DocItem](../eu.europa.ec.eudi.iso18013.transfer.response/-doc-item/index.md) for mso_mdoc document items. Includes the namespace and element identifier of the document item. |
| [ProcessedDeviceRequest](-processed-device-request/index.md) | [androidJvm]<br>class [ProcessedDeviceRequest](-processed-device-request/index.md)(documentManager: DocumentManager, sessionTranscript: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html), val requestedDocuments: [RequestedDocuments](../eu.europa.ec.eudi.iso18013.transfer.response/-requested-documents/index.md)) : [RequestProcessor.ProcessedRequest.Success](../eu.europa.ec.eudi.iso18013.transfer.response/-request-processor/-processed-request/-success/index.md)<br>Implementation of [RequestProcessor.ProcessedRequest.Success](../eu.europa.ec.eudi.iso18013.transfer.response/-request-processor/-processed-request/-success/index.md) for [DeviceRequest](-device-request/index.md). |
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ Represents a response that contains the document data that will be sent to an md
| 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 |
| [documentId](document-id.md) | [androidJvm]<br>val [documentId](document-id.md): DocumentId<br>the unique id of the document stored in identity credential api |
| [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 @@ -4,5 +4,4 @@

[androidJvm]\
constructor(
namespace: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html),
elementIdentifier: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
# elementIdentifier

[androidJvm]\
open
val [elementIdentifier](element-identifier.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
//[transfer-manager](../../../index.md)/[eu.europa.ec.eudi.iso18013.transfer.response](../index.md)/[DocItem](index.md)/[equals](equals.md)

# equals

[androidJvm]\
open operator override fun [equals](equals.md)(
other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
//[transfer-manager](../../../index.md)/[eu.europa.ec.eudi.iso18013.transfer.response](../index.md)/[DocItem](index.md)/[hashCode](hash-code.md)

# hashCode

[androidJvm]\
open override
fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,32 @@

# DocItem

[androidJvm]\
data class [DocItem](index.md)(val
namespace: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val
open class [DocItem](index.md)(val
elementIdentifier: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))

Doc item represents a data element

#### Inheritors

| |
|--------------------------------------------------------------------------------------------------|
| [MsoMdocItem](../../eu.europa.ec.eudi.iso18013.transfer.response.device/-mso-mdoc-item/index.md) |

## Constructors

| | |
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [DocItem](-doc-item.md) | [androidJvm]<br>constructor(namespace: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), elementIdentifier: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) |
| | |
|-------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| [DocItem](-doc-item.md) | [androidJvm]<br>constructor(elementIdentifier: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) |

## Properties

| Name | Summary |
|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [elementIdentifier](element-identifier.md) | [androidJvm]<br>val [elementIdentifier](element-identifier.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the data element identifier e.g. family_name, given_name |
| [namespace](namespace.md) | [androidJvm]<br>val [namespace](namespace.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the namespace that the element belong to, e.g. eu.europa.ec.eudiw.pid.1 |
| Name | Summary |
|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [elementIdentifier](element-identifier.md) | [androidJvm]<br>open val [elementIdentifier](element-identifier.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>the data element identifier e.g. family_name, given_name |

## Functions

| Name | Summary |
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [equals](equals.md) | [androidJvm]<br>open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
| [hashCode](hash-code.md) | [androidJvm]<br>open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
[androidJvm]\
constructor(documentId: DocumentId,
requestedItems: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)
&lt;[DocItem](../-doc-item/index.md), [IntentToRetain](../../eu.europa.ec.eudi.iso18013.transfer/-intent-to-retain/index.md)
&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)?)
Loading
Loading