Partilhar via

PosCommon Class (Documentação do SDK do POS para .NET v1.14)

PosCommoné a classe Base para todas as classes de Interface específicas, e todos os Objetos de Serviço derivam indiretamente dela. PosCommon define as propriedades, métodos e eventos comuns que a especificação UnifiedPOS (Unified Point Of Service) requer em todas as classes de dispositivo.

PosCommon Propriedades

A tabela a seguir descreve as propriedades da classe PosCommon disponível para aplicativos POS.

Propriedade Type Description
CapCompareFirmwareVersion booleano Indica se o objeto de serviço e o dispositivo suportam a comparação da versão de firmware no dispositivo físico com a de um arquivo de firmware.
CapPowerReporting PowerReporting enum Indica os recursos de relatório de energia do dispositivo.
CapStatisticsReporting booleano Indica se o dispositivo pode se acumular e pode fornecer várias estatísticas sobre o uso.
CapUpdateEstatísticas booleano Se definido como true, algumas ou todas as estatísticas do dispositivo podem ser redefinidas para 0 (zero) usando o método ResetStatistic para uma atualização e o método ResetStatistics para uma lista de atualizações, ou atualizadas usando o método UpdateStatistic para uma atualização e o método UpdateStatistics para uma lista de atualizações com os valores especificados correspondentes.
CapUpdateFirmware booleano Indica se o firmware do dispositivo pode ser atualizado através do método UpdateFirmware.
CheckHealthText string Indica a integridade do dispositivo.
Reivindicação booleano Indica se o dispositivo é reivindicado para acesso exclusivo.
Descrição do dispositivo string Contém uma cadeia de caracteres que identifica o dispositivo e a empresa que o fabricou.
Habilitado para dispositivo booleano Indica se o dispositivo está em um estado operacional.
Nome do dispositivo string UnifiedPOS chama-lhe PhysicalDeviceName; OLE for Retail POS (OPOS) chama-lhe DeviceName.
DevicePath string Definido pelo POS para .NET para dispositivos Plug and Play. Para dispositivos que não sejam Plug and Play, o DevicePath pode ser atribuído usando um arquivo de configuração.
FreezeEvents booleano Quando definido como true, o aplicativo solicitou que o objeto de serviço não entregue eventos.
PowerNotify Enum PowerNotification Contém o tipo de seleção de notificação de energia feita pelo aplicativo.
Estado de Potência Enum PowerState Mantém a condição de alimentação atual.
ServiceObjectDescription string Identifica o Objeto de Serviço que suporta o dispositivo e a empresa que o produziu. Esta propriedade está listada como DeviceServiceDescription na especificação UnifiedPOS.
ServiceObjectVersion System.Version Contém o número da versão do objeto de serviço. Esta propriedade está listada como DeviceServiceVersion na especificação UnifiedPOS.
Estado Enum ControlState Mantém o estado atual do dispositivo.
SynchronizingObject ISynchronizeInvoke Obtém ou define o objeto de empacotamento para chamadas do manipulador de eventos de um evento POS.

Métodos PosCommon

A tabela a seguir descreve os métodos da classe PosCommon disponíveis para aplicativos.

Método Tipo de Retorno Description
Verificar Saúde string Executa uma verificação de integridade no dispositivo. O tipo de verificação a ser realizada é indicado pelo parâmetro HealthCheckLevel. O método também atualiza a propriedade CheckHealthText.
Afirmação Vazio Solicita acesso exclusivo ao dispositivo. Os criadores de objetos de serviço são aconselhados a lançar exceções apenas em condições inesperadas; por exemplo, OutOfMemory. Caso contrário, os Objetos de Serviço devem retornar True se o dispositivo foi reivindicado e False se ocorreu um tempo limite.
Fechar Vazio Libera o dispositivo e seus recursos.
CompareFirmwareVersion CompareFirmwareResult Determina se a versão do firmware especificado é mais recente que, mais antiga ou igual à versão do firmware no dispositivo físico.
DirectIO DirectIOData Usado para se comunicar diretamente com o objeto de serviço. Na especificação UnifiedPOS, ele tem dois parâmetros de entrada/saída. Como usado pelo POS para .NET, esse método retorna uma estrutura e nenhum parâmetro de entrada/saída.
Abertura Vazio Abre um dispositivo para processamento de entrada/saída subsequente.
Versão Vazio Libera acesso exclusivo ao dispositivo.
ResetStatistic Vazio Redefine a estatística especificada como zero. Usado no POS para .NET para operações em uma única estatística.
ResetStatistics Vazio Redefine todas as estatísticas de uma categoria especificada para 0 (zero).
ResetStatistics Vazio Redefine as estatísticas especificadas para 0 (zero).
ResetStatistics Vazio Redefine todas as estatísticas associadas a um dispositivo para 0 (zero).
RetrieveStatistic string Recupera a estatística do dispositivo especificado. Usado no POS para .NET para operações em uma única estatística.
RecuperarEstatísticas string Recupera todas as estatísticas do dispositivo.
RecuperarEstatísticas Vazio Recupera as estatísticas da categoria especificada.
RecuperarEstatísticas Vazio Recupera as estatísticas especificadas.
UpdateFirmware Vazio Atualiza o firmware de um dispositivo com a versão do firmware contida no nome de arquivo especificado.
UpdateStatistic Vazio Atualiza uma estatística. Adicionado ao POS para .NET para operações em uma única estatística.
UpdateStatistics Vazio Atualiza uma lista de estatísticas com os valores especificados correspondentes.
UpdateStatistics Vazio Atualiza a categoria especificada de estatísticas com o valor especificado.

Eventos PosCommon

A tabela a seguir descreve os eventos de classe PosCommon .

Método Description
DirectIOEvent Gerado pelo objeto de serviço para comunicar informações diretamente ao aplicativo.
StatusUpdateEvent Gerado pelo objeto de serviço para alertar o aplicativo de uma alteração de status do dispositivo.

Exemplo

O exemplo de código a seguir demonstra como usar as propriedades e métodos comuns a todos os objetos de serviço para exibir informações sobre um dispositivo conectado.

// Create a derived class of PosCommon
public class PosCommonSample: PosCommon
{
    // Implement all base methods and properties.
    // ...
}

// Create instances for the example.
PosExplorer explorer = new PosExplorer();
PosCommonSample pcs = new PosCommonSample();
DeviceInfo device = explorer.GetDevice("MSR");
pcs = (PosCommonSample)explorer.CreateInstance(device);

// Open and claim the device, then print information
// about the device to the console.
pcs.Open();
pcs.Claim(1000);
Console.WriteLine("Name: {0}", pcs.DeviceName);
Console.WriteLine("Description: {0}", pcs.DeviceDescription);
Console.WriteLine("Path: {0}", pcs.DevicePath);
Console.WriteLine("Enabled: {0}", pcs.DeviceEnabled);

pcs.Close();

Consulte Também

Conceitos

  • Last updated on