@azure/storage-queue
Version:
Microsoft Azure Storage SDK for JavaScript - Queue
102 lines • 4.06 kB
JavaScript
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import * as coreClient from "@azure/core-client";
import * as Mappers from "../models/mappers.js";
import * as Parameters from "../models/parameters.js";
/** Class containing MessageId operations. */
export class MessageIdImpl {
client;
/**
* Initialize a new instance of the class MessageId class.
* @param client Reference to the service client
*/
constructor(client) {
this.client = client;
}
/**
* The Update operation was introduced with version 2011-08-18 of the Queue service API. The Update
* Message operation updates the visibility timeout of a message. You can also use this operation to
* update the contents of a message. A message must be in a format that can be included in an XML
* request with UTF-8 encoding, and the encoded message can be up to 64KB in size.
* @param popReceipt Required. Specifies the valid pop receipt value returned from an earlier call to
* the Get Messages or Update Message operation.
* @param visibilityTimeout Optional. Specifies the new visibility timeout value, in seconds, relative
* to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1
* second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to
* version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry
* time.
* @param options The options parameters.
*/
update(popReceipt, visibilityTimeout, options) {
return this.client.sendOperationRequest({ popReceipt, visibilityTimeout, options }, updateOperationSpec);
}
/**
* The Delete operation deletes the specified message.
* @param popReceipt Required. Specifies the valid pop receipt value returned from an earlier call to
* the Get Messages or Update Message operation.
* @param options The options parameters.
*/
delete(popReceipt, options) {
return this.client.sendOperationRequest({ popReceipt, options }, deleteOperationSpec);
}
}
// Operation Specifications
const xmlSerializer = coreClient.createSerializer(Mappers, /* isXml */ true);
const updateOperationSpec = {
path: "/{queueName}/messages/{messageid}",
httpMethod: "PUT",
responses: {
204: {
headersMapper: Mappers.MessageIdUpdateHeaders
},
default: {
bodyMapper: Mappers.StorageError,
headersMapper: Mappers.MessageIdUpdateExceptionHeaders
}
},
requestBody: Parameters.queueMessage1,
queryParameters: [
Parameters.timeoutInSeconds,
Parameters.popReceipt,
Parameters.visibilityTimeout1
],
urlParameters: [Parameters.url],
headerParameters: [
Parameters.contentType,
Parameters.accept,
Parameters.version,
Parameters.requestId
],
isXML: true,
contentType: "application/xml; charset=utf-8",
mediaType: "xml",
serializer: xmlSerializer
};
const deleteOperationSpec = {
path: "/{queueName}/messages/{messageid}",
httpMethod: "DELETE",
responses: {
204: {
headersMapper: Mappers.MessageIdDeleteHeaders
},
default: {
bodyMapper: Mappers.StorageError,
headersMapper: Mappers.MessageIdDeleteExceptionHeaders
}
},
queryParameters: [Parameters.timeoutInSeconds, Parameters.popReceipt],
urlParameters: [Parameters.url],
headerParameters: [
Parameters.version,
Parameters.requestId,
Parameters.accept1
],
isXML: true,
serializer: xmlSerializer
};
//# sourceMappingURL=messageId.js.map