DocumentApi class

Available extensions

• DocumentApiCrypto

Constructors

DocumentApi([ApiClient? apiClient])

Properties

apiClient → ApiClient

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createDocument(UserDto user, DecryptedDocumentDto document, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<DecryptedDocumentDto?>

Available on DocumentApi, provided by the DocumentApiCrypto extension

deleteAttachment(UserDto user, String documentId, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<DecryptedDocumentDto?>

Available on DocumentApi, provided by the DocumentApiCrypto extension

findByDocTypeHCPartyAndMessage(UserDto user, String documentType, String hcpId, DecryptedMessageDto message, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<List<DecryptedDocumentDto>>

Available on DocumentApi, provided by the DocumentApiCrypto extension

findByDocTypeHCPartyAndMessageForeignKeys(UserDto user, String documentType, String hcpId, String messageSecretForeignKeys, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<List<DecryptedDocumentDto>>

Available on DocumentApi, provided by the DocumentApiCrypto extension

findByHCPartyAndPatient(UserDto user, String hcpId, DecryptedPatientDto patient, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<List<DecryptedDocumentDto>>

Available on DocumentApi, provided by the DocumentApiCrypto extension

findByHCPartyAndPatientForeignKeys(UserDto user, String hcpId, String patientSecretForeignKeys, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<List<DecryptedDocumentDto>>

Available on DocumentApi, provided by the DocumentApiCrypto extension

findWithoutDelegations(UserDto user, int? limit, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<List<DecryptedDocumentDto>>

Available on DocumentApi, provided by the DocumentApiCrypto extension

getDocument(UserDto user, String documentId, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<DecryptedDocumentDto?>

Available on DocumentApi, provided by the DocumentApiCrypto extension

getDocuments(UserDto user, ListOfIdsDto listOfIdsDto, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<List<DecryptedDocumentDto>>

Available on DocumentApi, provided by the DocumentApiCrypto extension

getDocumentsByExternalUuid(UserDto user, String externalUuid, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<List<DecryptedDocumentDto>>

Available on DocumentApi, provided by the DocumentApiCrypto extension

modifyDocument(UserDto user, DecryptedDocumentDto document, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<DecryptedDocumentDto?>

Available on DocumentApi, provided by the DocumentApiCrypto extension

modifyDocuments(UserDto user, List<DecryptedDocumentDto> documents, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<List<DecryptedDocumentDto>?>

Available on DocumentApi, provided by the DocumentApiCrypto extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rawCreateDocument(DocumentDto documentDto) → Future<DocumentDto?>

Creates a document

rawCreateDocumentWithHttpInfo(DocumentDto documentDto) → Future<Response>

Creates a document

rawDeleteAttachment(String documentId) → Future<DocumentDto?>

Deletes a document's attachment

rawDeleteAttachmentWithHttpInfo(String documentId) → Future<Response>

Deletes a document's attachment

rawDeleteDocument(ListOfIdsDto listOfIdsDto) → Future<List<DocIdentifier>?>

Deletes documents

rawDeleteDocumentWithHttpInfo(ListOfIdsDto listOfIdsDto) → Future<Response>

Deletes documents

rawFindWithoutDelegation({int? limit}) → Future<List<DocumentDto>?>

List documents with no delegation

rawFindWithoutDelegationWithHttpInfo({int? limit}) → Future<Response>

List documents with no delegation

rawGetDocument(String documentId) → Future<DocumentDto?>

Gets a document

rawGetDocumentAttachment(String documentId, String attachmentId, {String? enckeys, String? fileName}) → Future<MultipartFile?>

Load document's attachment

rawGetDocumentAttachmentWithHttpInfo(String documentId, String attachmentId, {String? enckeys, String? fileName}) → Future<Response>

Load document's attachment

rawGetDocumentByExternalUuid(String externalUuid) → Future<DocumentDto?>

Gets a document

rawGetDocumentByExternalUuidWithHttpInfo(String externalUuid) → Future<Response>

Gets a document

rawGetDocuments(ListOfIdsDto listOfIdsDto) → Future<List<DocumentDto>?>

Gets a document

rawGetDocumentsByExternalUuid(String externalUuid) → Future<List<DocumentDto>?>

Get all documents with externalUuid

rawGetDocumentsByExternalUuidWithHttpInfo(String externalUuid) → Future<Response>

Get all documents with externalUuid

rawGetDocumentsWithHttpInfo(ListOfIdsDto listOfIdsDto) → Future<Response>

Gets a document

rawGetDocumentWithHttpInfo(String documentId) → Future<Response>

Gets a document

rawListDocumentByTypeHCPartyMessageSecretFKeys(String documentTypeCode, String hcPartyId, String secretFKeys) → Future<List<DocumentDto>?>

List documents found By type, By Healthcare Party and secret foreign keys.

rawListDocumentByTypeHCPartyMessageSecretFKeysWithHttpInfo(String documentTypeCode, String hcPartyId, String secretFKeys) → Future<Response>

List documents found By type, By Healthcare Party and secret foreign keys.

rawListDocumentsByHCPartyAndPatientForeignKeys(String hcPartyId, String secretFKeys) → Future<List<DocumentDto>?>

List documents found By Healthcare Party and secret foreign keys.

rawListDocumentsByHCPartyAndPatientForeignKeysWithHttpInfo(String hcPartyId, String secretFKeys) → Future<Response>

List documents found By Healthcare Party and secret foreign keys.

rawModifyDocument(DocumentDto documentDto) → Future<DocumentDto?>

Updates a document

rawModifyDocuments(List<DocumentDto> documentDto) → Future<List<DocumentDto>?>

Updates a batch of documents

rawModifyDocumentsWithHttpInfo(List<DocumentDto> documentDto) → Future<Response>

Updates a batch of documents

rawModifyDocumentWithHttpInfo(DocumentDto documentDto) → Future<Response>

Updates a document

rawSetDocumentAttachment(String documentId, ByteStream attachment, {String? enckeys}) → Future<DocumentDto?>

Creates a document's attachment

rawSetDocumentAttachmentMulti(String documentId, MultipartFile attachment, {String? enckeys}) → Future<DocumentDto?>

Creates a document's attachment

rawSetDocumentAttachmentMultiWithHttpInfo(String documentId, MultipartFile attachment, {String? enckeys}) → Future<Response>

Creates a document's attachment

rawSetDocumentAttachmentWithHttpInfo(String documentId, ByteStream body, {String? enckeys}) → Future<Response>

Creates a document's attachment

rawSetDocumentsDelegations(List<IcureStubDto> icureStubDto) → Future<List<IcureStubDto>?>

Update delegations in healthElements.

rawSetDocumentsDelegationsWithHttpInfo(List<IcureStubDto> icureStubDto) → Future<Response>

Update delegations in healthElements.

rawSetSafeDocumentAttachment(String documentId, MultipartFile body, {String? enckeys}) → Future<DocumentDto?>

Creates a document's attachment

rawSetSafeDocumentAttachmentWithHttpInfo(String documentId, MultipartFile body, {String? enckeys}) → Future<Response>

Creates a document's attachment

setAttachmentTo(UserDto user, String documentId, ByteStream attachment, String? docEncKeys, CryptoConfig<DecryptedDocumentDto, DocumentDto> config) → Future<DecryptedDocumentDto?>

Available on DocumentApi, provided by the DocumentApiCrypto extension

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited