ReceiveBatchOptions -> ReceiveMessagesOptions

Azure · Jun 24, 2020 · 3415f1d · 3415f1d
1 parent fa14073
commit 3415f1d
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/sdk/servicebus/service-bus/review/service-bus.api.md b/sdk/servicebus/service-bus/review/service-bus.api.md
@@ -175,10 +175,6 @@ export interface QueuesResponse extends Array<QueueDescription>, Response {
 export interface QueuesRuntimeInfoResponse extends Array<QueueRuntimeInfo>, Response {
 }
 
-// @public
-export interface ReceiveBatchOptions extends OperationOptions, WaitTimeOptions {
-}
-
 // @public
 export interface ReceivedMessage extends ServiceBusMessage {
     readonly _amqpMessage: AmqpMessage;
@@ -207,6 +203,10 @@ export interface ReceivedMessageWithLock extends ReceivedMessage {
     renewLock(): Promise<Date>;
 }
 
+// @public
+export interface ReceiveMessagesOptions extends OperationOptions, WaitTimeOptions {
+}
+
 // @public
 export interface Receiver<ReceivedMessageT> {
     close(): Promise<void>;
@@ -216,7 +216,7 @@ export interface Receiver<ReceivedMessageT> {
     isReceivingMessages(): boolean;
     peekMessages(options?: PeekMessagesOptions): Promise<ReceivedMessage[]>;
     receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptions): Promise<ReceivedMessageT[]>;
-    receiveMessages(maxMessages: number, options?: ReceiveBatchOptions): Promise<ReceivedMessageT[]>;
+    receiveMessages(maxMessages: number, options?: ReceiveMessagesOptions): Promise<ReceivedMessageT[]>;
     receiveMode: "peekLock" | "receiveAndDelete";
     subscribe(handlers: MessageHandlers<ReceivedMessageT>, options?: SubscribeOptions): void;
 }

diff --git a/sdk/servicebus/service-bus/src/index.ts b/sdk/servicebus/service-bus/src/index.ts
@@ -22,7 +22,7 @@ export {
   MessageHandlerOptions,
   MessageHandlers,
   PeekMessagesOptions,
-  ReceiveBatchOptions,
+  ReceiveMessagesOptions,
   SenderOpenOptions,
   SubscribeOptions,
   WaitTimeOptions

diff --git a/sdk/servicebus/service-bus/src/models.ts b/sdk/servicebus/service-bus/src/models.ts
@@ -56,7 +56,7 @@ export interface CreateBatchOptions extends OperationOptions {
 /**
  * Options when receiving a batch of messages from Service Bus.
  */
-export interface ReceiveBatchOptions extends OperationOptions, WaitTimeOptions {}
+export interface ReceiveMessagesOptions extends OperationOptions, WaitTimeOptions {}
 
 /**
  * Options when getting an iterable iterator from Service Bus.

diff --git a/sdk/servicebus/service-bus/src/receivers/receiver.ts b/sdk/servicebus/service-bus/src/receivers/receiver.ts
@@ -5,7 +5,7 @@ import {
   PeekMessagesOptions,
   GetMessageIteratorOptions,
   MessageHandlers,
-  ReceiveBatchOptions,
+  ReceiveMessagesOptions,
   SubscribeOptions
 } from "../models";
 import { OperationOptions } from "../modelsToBeSharedWithEventHubs";
@@ -51,7 +51,7 @@ export interface Receiver<ReceivedMessageT> {
    * @param maxMessages The maximum number of messages to accept.
    * @param options Options for receiveMessages
    */
-  receiveMessages(maxMessages: number, options?: ReceiveBatchOptions): Promise<ReceivedMessageT[]>;
+  receiveMessages(maxMessages: number, options?: ReceiveMessagesOptions): Promise<ReceivedMessageT[]>;
 
   /**
    * Returns a promise that resolves to an array of deferred messages identified by given `sequenceNumbers`.
@@ -256,7 +256,7 @@ export class ReceiverImpl<ReceivedMessageT extends ReceivedMessage | ReceivedMes
    */
   async receiveMessages(
     maxMessageCount: number,
-    options?: ReceiveBatchOptions
+    options?: ReceiveMessagesOptions
   ): Promise<ReceivedMessageT[]> {
     this._throwIfReceiverOrConnectionClosed();
     this._throwIfAlreadyReceiving();

diff --git a/sdk/servicebus/service-bus/src/receivers/sessionReceiver.ts b/sdk/servicebus/service-bus/src/receivers/sessionReceiver.ts
@@ -4,7 +4,7 @@
 import { ClientEntityContext } from "../clientEntityContext";
 import {
   MessageHandlers,
-  ReceiveBatchOptions,
+  ReceiveMessagesOptions,
   ReceivedMessage,
   SessionMessageHandlerOptions,
   SubscribeOptions
@@ -439,7 +439,7 @@ export class SessionReceiverImpl<ReceivedMessageT extends ReceivedMessage | Rece
    */
   async receiveMessages(
     maxMessageCount: number,
-    options?: ReceiveBatchOptions
+    options?: ReceiveMessagesOptions
   ): Promise<ReceivedMessageT[]> {
     this._throwIfReceiverOrConnectionClosed();
     this._throwIfAlreadyReceiving();