QueueClient class

Cria uma instância de QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parâmetros

Cria uma instância de QueueClient.

new QueueClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parâmetros

Cria uma instância de QueueClient.

new QueueClient(connectionString: string, queueName: string, options?: StoragePipelineOptions)

Parâmetros

accountName: string

Valor da propriedade

O nome da fila.

string name

Valor da propriedade

Valor da cadeia de caracteres de URL.

url: string

Valor da propriedade

Limpar exclui todas as mensagens de uma fila.

function clearMessages(options?: QueueClearMessagesOptions)

Parâmetros

Retornos

Dados de resposta para a operação de mensagens claras.

Cria uma nova fila na conta especificada.

function create(options?: QueueCreateOptions)

Parâmetros

Retornos

Dados de resposta para a operação de criação de fila.

Uso de exemplo:

const queueClient = queueServiceClient.getQueueClient("<new queue name>");
const createQueueResponse = await queueClient.create();

Criará uma nova fila na conta especificada se ela ainda não existir. Se a fila já existir, ela não será alterada.

function createIfNotExists(options?: QueueCreateOptions)

Parâmetros

Retornos

Exclui a fila especificada permanentemente.

function delete(options?: QueueDeleteOptions)

Parâmetros

Retornos

Dados de resposta para a operação de exclusão de fila.

Uso de exemplo:

const deleteQueueResponse = await queueClient.delete();
console.log(
  "Delete queue successfully, service assigned request Id:", deleteQueueResponse.requestId
);

Exclui a fila especificada permanentemente se ela existir.

function deleteIfExists(options?: QueueDeleteOptions)

Parâmetros

Retornos

deleteMessage remove permanentemente a mensagem especificada de sua fila.

function deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions)

Parâmetros

Retornos

Dados de resposta para a operação de exclusão de mensagem.

Retornará true se a fila especificada existir; false caso contrário. OBSERVAÇÃO: use essa função com cuidado, pois uma fila existente pode ser excluída por outros clientes ou aplicativos. Vice-versa, novas filas podem ser adicionadas por outros clientes ou aplicativos após a conclusão dessa função.

function exists(options?: QueueExistsOptions)

Parâmetros

Retornos

Disponível apenas para QueueClient construído com uma credencial de chave compartilhada. Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

function generateSasUrl(options: QueueGenerateSasUrlOptions)

Parâmetros

Retornos

O URI de SAS que consiste no URI para o recurso representado por esse cliente, seguido pelo token SAS gerado.

Obtém detalhes sobre as políticas de acesso armazenadas especificadas na fila que podem ser usadas com Assinaturas de Acesso Compartilhado. AVISO: a Data do JavaScript potencialmente perderá a precisão ao analisar a cadeia de caracteres de início e expiração. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".

function getAccessPolicy(options?: QueueGetAccessPolicyOptions)

Parâmetros

Retornos

Dados de resposta para a operação de política de acesso da Fila.

Obtém todos os metadados definidos pelo usuário e as propriedades do sistema para a fila especificada. Os metadados são associados à fila como pares nome-valor.

function getProperties(options?: QueueGetPropertiesOptions)

Parâmetros

Retornos

Dados de resposta para a operação de obtenção de propriedades da fila.

PeekMessages recupera uma ou mais mensagens da frente da fila, mas não altera a visibilidade da mensagem.

function peekMessages(options?: QueuePeekMessagesOptions)

Parâmetros

Retornos

Dados de resposta para a operação de espiar mensagens.

Uso de exemplo:

const peekMessagesResponse = await queueClient.peekMessages();
console.log("The peeked message is:", peekMessagesResponse.peekedMessageItems[0].messageText);

receiveMessages recupera uma ou mais mensagens da frente da fila.

function receiveMessages(options?: QueueReceiveMessageOptions)

Parâmetros

Retornos

Dados de resposta para a operação de recebimento de mensagens.

Uso de exemplo:

const response = await queueClient.receiveMessages();
if (response.receivedMessageItems.length == 1) {
  const receivedMessageItem = response.receivedMessageItems[0];
  console.log("Processing & deleting message with content:", receivedMessageItem.messageText);
  const deleteMessageResponse = await queueClient.deleteMessage(
    receivedMessageItem.messageId,
    receivedMessageItem.popReceipt
  );
  console.log(
    "Delete message successfully, service assigned request Id:",
    deleteMessageResponse.requestId
  );
}

sendMessage adiciona uma nova mensagem à parte de trás de uma fila. O tempo limite de visibilidade especifica por quanto tempo a mensagem deve ficar invisível para operações Dequeue e Peek. O conteúdo da mensagem tem até 64 KB de tamanho e deve estar em um formato que possa ser incluído em uma solicitação XML com codificação UTF-8. Para incluir a marcação na mensagem, o conteúdo da mensagem deve ser com escape XML ou codificado em Base64.

function sendMessage(messageText: string, options?: QueueSendMessageOptions)

Parâmetros

Retornos

Dados de resposta para a operação de envio de mensagens.

Uso de exemplo:

const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  "Sent message successfully, service assigned message Id:", sendMessageResponse.messageId,
  "service assigned request Id:", sendMessageResponse.requestId
);

Define políticas de acesso armazenadas para a fila que pode ser usada com Assinaturas de Acesso Compartilhado.

function setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions)

Parâmetros

Retornos

Dados de resposta para a operação de política de acesso do conjunto de filas.

Define um ou mais pares nome-valor definidos pelo usuário para a fila especificada. Se nenhuma opção for fornecida ou nenhum metadados definido no parâmetro de opção, os metadados da fila serão removidos.

function setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions)

Parâmetros

Retornos

Dados de resposta para a operação de metadados do conjunto de filas.

A atualização altera o tempo limite e o conteúdo da visibilidade de uma mensagem. O conteúdo da mensagem tem até 64 KB de tamanho e deve estar em um formato que possa ser incluído em uma solicitação XML com codificação UTF-8. Para incluir a marcação na mensagem, o conteúdo da mensagem deve ser com escape XML ou codificado em Base64.

function updateMessage(messageId: string, popReceipt: string, message?: string, visibilityTimeout?: number, options?: QueueUpdateMessageOptions)

Parâmetros

Retornos

Dados de resposta para a operação de atualização de mensagem.