Class ServicoBase
Classe base abstrata para elaboração dos serviços dos documentos fiscais eletrônicos (NFe, NFCe, MDFe, NFSe, CTe, GNRE, etc...)
Inheritance
Inherited Members
Namespace: Unimake.Business.DFe.Servicos
Assembly: Unimake.Business.DFe.dll
Syntax
public abstract class ServicoBase
Constructors
ServicoBase()
Construtor
Declaration
protected ServicoBase()
Properties
Configuracoes
Configurações diversas para consumir os serviços
Declaration
public Configuracao Configuracoes { get; set; }
Property Value
| Type | Description |
|---|---|
| Configuracao |
ConteudoXML
Conteúdo do XML, pode ou não estar assinado. Esta propriedade é utilizada em tempo de processamento. Utilize as propriedades ConteudoXMLOriginal ou ConteudoXMLAssinado para recuperar o que você deseja fora da classe.
Declaration
protected XmlDocument ConteudoXML { get; set; }
Property Value
| Type | Description |
|---|---|
| XmlDocument |
ConteudoXMLAssinado
Conteúdo do XML assinado.
Declaration
public virtual XmlDocument ConteudoXMLAssinado { get; }
Property Value
| Type | Description |
|---|---|
| XmlDocument |
ConteudoXMLOriginal
Conteúdo do XML original, para os que tem assinatura este está sem. Original conforme foi criado.
Declaration
public XmlDocument ConteudoXMLOriginal { get; }
Property Value
| Type | Description |
|---|---|
| XmlDocument |
HttpStatusCode
Propriedade para uso interno nos testes unitários.
Declaration
public HttpStatusCode HttpStatusCode { get; }
Property Value
| Type | Description |
|---|---|
| HttpStatusCode |
RetornoStream
Stream retornada pelo Webservice. Para consumo de serviços que retornam .pdf
Declaration
public Stream RetornoStream { get; set; }
Property Value
| Type | Description |
|---|---|
| Stream |
RetornoWSString
String do XML retornado pelo WebService
Declaration
public string RetornoWSString { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
RetornoWSXML
XML retornado pelo Web-service
Declaration
public XmlDocument RetornoWSXML { get; set; }
Property Value
| Type | Description |
|---|---|
| XmlDocument |
Warnings
Exceções que não interrompem o fluxo do sistema, sendo registradas apenas como avisos ou alertas.
Declaration
public List<ValidatorDFeException> Warnings { get; protected set; }
Property Value
| Type | Description |
|---|---|
| List<ValidatorDFeException> |
Methods
AjustarXMLAposAssinado()
Este método é uma possibilidade de fazer ajustes no XML depois de assinado, pois ele é executado assim que a assinatura é feita. Basta implementar ele nas heranças.
Declaration
protected virtual void AjustarXMLAposAssinado()
DefinirConfiguracao()
Defini o valor das propriedades do objeto "Configuracoes"
Declaration
protected virtual void DefinirConfiguracao()
Executar()
Executar o serviço para consumir o web-service
Declaration
public virtual void Executar()
GravarXmlDistribuicao(string, string, string)
Gravar o XML de distribuição em uma pasta no HD
Declaration
public abstract void GravarXmlDistribuicao(string pasta, string nomeArquivo, string conteudoXML)
Parameters
| Type | Name | Description |
|---|---|---|
| string | pasta | Pasta onde deve ser gravado o XML no HD |
| string | nomeArquivo | Nome do arquivo a ser gravado no HD |
| string | conteudoXML | String contendo o conteúdo do XML a ser gravado no HD |
Inicializar(XmlDocument, Configuracao)
Inicializa configurações, parâmetros e propriedades para execução do serviço.
Declaration
protected virtual void Inicializar(XmlDocument conteudoXML, Configuracao configuracao)
Parameters
| Type | Name | Description |
|---|---|---|
| XmlDocument | conteudoXML | Conteúdo do XML a ser enviado para o web-service |
| Configuracao | configuracao | Configurações a serem utilizadas para conexão e envio do XML para o web-service |
VerificarAssinarXML(string, string)
Verifica se o XML está assinado, se não estiver assina. Só faz isso para XMLs que tem tag de assinatura, demais ele mantem como está, sem assinar.
Declaration
protected virtual void VerificarAssinarXML(string tagAssinatura, string tagAtributoID)
Parameters
| Type | Name | Description |
|---|---|---|
| string | tagAssinatura | Tag de assinatura |
| string | tagAtributoID | Tag que detêm o atributo ID |
XmlValidar()
Validar o schema do XML
Declaration
protected abstract void XmlValidar()
XmlValidarConteudo()
Validar o conteúdo das tags do XML, alguns validações manuais que o schema não faz. Vamos implementando novas regras na medida da necessidade de cada serviço.
Declaration
protected abstract void XmlValidarConteudo()