EnvelopeInterface
in
Interfaz para la clase que representa un sobre con documentos.
Table of Contents
Methods
- addDocument() : static
- Agrega un documento al sobre.
- addMetadata() : static
- Agrega una clave específica a los metadatos.
- countDocuments() : int
- Obtiene la cantidad de documentos en el sobre.
- getBusinessMessageID() : string
- Obtiene el identificador único del mensaje comercial encapsulado.
- getCreationDateAndTime() : DateTimeInterface
- Obtiene la fecha y hora de creación del sobre.
- getDocuments() : array<string|int, DocumentInterface>
- Obtiene la lista de documentos que hay en el sobre.
- getDocumentType() : DocumentType
- Obtiene el tipo de documento que el sobre contiene.
- getMetadata() : BagInterface
- Obtiene los metadatos del sobre.
- getOriginalBusinessMessageID() : string|null
- Obtiene el identificador del mensaje original al que se responde con los documentos de este sobre.
- getProcess() : ProcessType
- Obtiene el proceso comercial o de negocio al que estan asociados los documentos del sobre.
- getReceiver() : ReceiverInterface
- Entrega el receptor del sobre.
- getSender() : SenderInterface
- Entrega el remitente del sobre.
- setDocuments() : static
- Asigna los documentos del sobre.
- setMetadata() : static
- Asigna los metadatos del sobre.
Methods
addDocument()
Agrega un documento al sobre.
public
addDocument(DocumentInterface $document) : static
Parameters
- $document : DocumentInterface
Return values
staticaddMetadata()
Agrega una clave específica a los metadatos.
public
addMetadata(string $key, mixed $value) : static
Parameters
- $key : string
- $value : mixed
Return values
staticcountDocuments()
Obtiene la cantidad de documentos en el sobre.
public
countDocuments() : int
Return values
intgetBusinessMessageID()
Obtiene el identificador único del mensaje comercial encapsulado.
public
getBusinessMessageID() : string
Return values
stringgetCreationDateAndTime()
Obtiene la fecha y hora de creación del sobre.
public
getCreationDateAndTime() : DateTimeInterface
Para sobres enviados será la fecha y hora de creación en LibreDTE del sobre. Para sobres recibidos se debe tratar de incluir la fecha y hora original que el emisor haya asignado (ej: fecha recepción correo).
Return values
DateTimeInterfacegetDocuments()
Obtiene la lista de documentos que hay en el sobre.
public
getDocuments() : array<string|int, DocumentInterface>
Return values
array<string|int, DocumentInterface>getDocumentType()
Obtiene el tipo de documento que el sobre contiene.
public
getDocumentType() : DocumentType
Todos los documentos deberán ser del mismo tipo.
Return values
DocumentTypegetMetadata()
Obtiene los metadatos del sobre.
public
getMetadata() : BagInterface
Estos son útiles para el proceso de intercambio y/o el medio de transporte usado para el intercambio.
Return values
BagInterfacegetOriginalBusinessMessageID()
Obtiene el identificador del mensaje original al que se responde con los documentos de este sobre.
public
getOriginalBusinessMessageID() : string|null
Return values
string|nullgetProcess()
Obtiene el proceso comercial o de negocio al que estan asociados los documentos del sobre.
public
getProcess() : ProcessType
Return values
ProcessTypegetReceiver()
Entrega el receptor del sobre.
public
getReceiver() : ReceiverInterface
Return values
ReceiverInterfacegetSender()
Entrega el remitente del sobre.
public
getSender() : SenderInterface
Return values
SenderInterfacesetDocuments()
Asigna los documentos del sobre.
public
setDocuments(array<string|int, DocumentInterface> $documents) : static
Parameters
- $documents : array<string|int, DocumentInterface>
Return values
staticsetMetadata()
Asigna los metadatos del sobre.
public
setMetadata(BagInterface|array<string|int, mixed> $metadata) : static
Parameters
- $metadata : BagInterface|array<string|int, mixed>