Compartilhar via


MessageIdURL class

Uma MessageIdURL representa uma URL para uma mensagem específica da Fila de Armazenamento do Azure, permitindo que você manipule a mensagem.

Extends

Construtores

MessageIdURL(string, Pipeline)

Cria uma instância de MessageIdURL.

Propriedades

pipeline

Pipeline de política de solicitação.

url

Valor da cadeia de caracteres de URL.

Métodos

delete(Aborter, string)

Excluir remove permanentemente a mensagem especificada de sua fila.

fromMessagesURL(MessagesURL, string)

Cria um objeto MessageIdURL de MessagesURL

newPipeline(Credential, INewPipelineOptions)

Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida.

update(Aborter, string, number, string)

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 uma marcação na mensagem, os conteúdos da mensagem devem ser ignorados por XML ou codificados como Base64.

withPipeline(Pipeline)

Cria um novo objeto MessageIdURL idêntico à origem, mas com o pipeline de política de solicitação especificado.

Detalhes do construtor

MessageIdURL(string, Pipeline)

Cria uma instância de MessageIdURL.

new MessageIdURL(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma cadeia de caracteres de URL apontando para a mensagem da fila do Armazenamento do Azure, como "https://myaccount.queue.core.windows.net/myqueue/messages/messageid". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.queue.core.windows.net/myqueue/messages/messageid?sasString".

pipeline
Pipeline

Chame StorageURL.newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.

Detalhes da propriedade

pipeline

Pipeline de política de solicitação.

pipeline: Pipeline

Valor da propriedade

url

Valor da cadeia de caracteres de URL.

url: string

Valor da propriedade

string

Detalhes do método

delete(Aborter, string)

Excluir remove permanentemente a mensagem especificada de sua fila.

function delete(aborter: Aborter, popReceipt: string)

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação

popReceipt

string

Um valor de recibo pop válido retornado de uma chamada anterior para a operação de mensagens de remoção ou de atualização.

Retornos

Promise<Models.MessageIdDeleteResponse>

fromMessagesURL(MessagesURL, string)

Cria um objeto MessageIdURL de MessagesURL

static function fromMessagesURL(messagesURL: MessagesURL, messageId: string)

Parâmetros

messagesURL
MessagesURL
messageId

string

Retornos

newPipeline(Credential, INewPipelineOptions)

Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

Parâmetros

credential
Credential

Como AnonymousCredential, SharedKeyCredential ou TokenCredential.

pipelineOptions
INewPipelineOptions

Retornos

Um novo objeto Pipeline.

update(Aborter, string, number, string)

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 uma marcação na mensagem, os conteúdos da mensagem devem ser ignorados por XML ou codificados como Base64.

function update(aborter: Aborter, popReceipt: string, visibilityTimeout: number, message: string)

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação

popReceipt

string

Um valor de recibo pop válido retornado de uma chamada anterior para a operação de mensagens de remoção ou de atualização.

visibilityTimeout

number

Especifica o novo valor de tempo limite de visibilidade, em segundos, em relação à hora do servidor. O novo valor deve ser maior ou igual a 0 e não pode ser maior que sete dias. O tempo limite de visibilidade de uma mensagem não pode ser definido como um valor posterior à data de expiração. É possível atualizar uma mensagem até que seja excluída ou expirar.

message

string

Mensagem a ser atualizada.

Retornos

Promise<Models.MessageIdUpdateResponse>

withPipeline(Pipeline)

Cria um novo objeto MessageIdURL idêntico à origem, mas com o pipeline de política de solicitação especificado.

function withPipeline(pipeline: Pipeline)

Parâmetros

pipeline
Pipeline

Retornos