QueueClient | @azure/storage-queue

Hierarchy

StorageClient
- QueueClient

Index

Constructors

constructor

Properties

Accessors

name

Methods

Constructors

constructor

new QueueClient(connectionString: string, queueName: string, options: StoragePipelineOptions): QueueClient
new QueueClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options: StoragePipelineOptions): QueueClient
new QueueClient(url: string, pipeline: Pipeline): QueueClient

Overrides StorageClient.constructor
- Defined in QueueClient.ts:446
Parameters
- connectionString: string
- queueName: string
- Optional options: StoragePipelineOptions
Returns QueueClient
Overrides StorageClient.constructor
- Defined in QueueClient.ts:461
Parameters
- url: string
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Optional options: StoragePipelineOptions
Returns QueueClient
Overrides StorageClient.constructor
- Defined in QueueClient.ts:477
Parameters
- url: string
- pipeline: Pipeline
Returns QueueClient

Properties

accountName

accountName: string

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Accessors

name

name:

Methods

clearMessages

clearMessages(options?: QueueClearMessagesOptions): Promise<QueueClearMessagesResponse>

- Defined in QueueClient.ts:826
Parameters
- Default value options: QueueClearMessagesOptions = {}
Returns Promise<QueueClearMessagesResponse>

Response data for the clear messages operation.

create

create(options?: QueueCreateOptions): Promise<QueueCreateResponse>

- Defined in QueueClient.ts:598
Parameters
- Default value options: QueueCreateOptions = {}
Returns Promise<QueueCreateResponse>

Response data for the Queue create operation.

delete

delete(options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

- Defined in QueueClient.ts:634
Parameters
- Default value options: QueueDeleteOptions = {}
Returns Promise<QueueDeleteResponse>

Response data for the Queue delete operation.

deleteMessage

deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions): Promise<QueueDeleteMessageResponse>

- Defined in QueueClient.ts:1034
Parameters
- messageId: string
- popReceipt: string
- Default value options: QueueDeleteMessageOptions = {}
Returns Promise<QueueDeleteMessageResponse>

Response data for the delete message operation.

getAccessPolicy

getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>

- Defined in QueueClient.ts:732
Parameters
- Default value options: QueueGetAccessPolicyOptions = {}
Returns Promise<QueueGetAccessPolicyResponse>

Response data for the Queue get access policy operation.

getProperties

getProperties(options?: QueueGetPropertiesOptions): Promise<QueueGetPropertiesResponse>

- Defined in QueueClient.ts:666
Parameters
- Default value options: QueueGetPropertiesOptions = {}
Returns Promise<QueueGetPropertiesResponse>

Response data for the Queue get properties operation.

peekMessages

peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>

- Defined in QueueClient.ts:987
Parameters
- Default value options: QueuePeekMessagesOptions = {}
Returns Promise<QueuePeekMessagesResponse>

Response data for the peek messages operation.

receiveMessages

receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>

- Defined in QueueClient.ts:935
Parameters
- Default value options: QueueReceiveMessageOptions = {}
Returns Promise<QueueReceiveMessageResponse>

Response data for the receive messages operation.

sendMessage

sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>

- Defined in QueueClient.ts:868
Parameters
- messageText: string
- Default value options: QueueSendMessageOptions = {}
Returns Promise<QueueSendMessageResponse>

Response data for the send messages operation.

setAccessPolicy

setAccessPolicy(queueAcl: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>

- Defined in QueueClient.ts:784
Parameters
- Optional queueAcl: SignedIdentifier[]
- Default value options: QueueSetAccessPolicyOptions = {}
Returns Promise<QueueSetAccessPolicyResponse>

Response data for the Queue set access policy operation.

setMetadata

setMetadata(metadata: Metadata, options?: QueueSetMetadataOptions): Promise<QueueSetMetadataResponse>

- Defined in QueueClient.ts:698
Parameters
- Optional metadata: Metadata
- Default value options: QueueSetMetadataOptions = {}
Returns Promise<QueueSetMetadataResponse>

Response data for the Queue set metadata operation.

updateMessage

updateMessage(messageId: string, popReceipt: string, message: string, visibilityTimeout: undefined | number, options?: QueueUpdateMessageOptions): Promise<QueueUpdateMessageResponse>

- Defined in QueueClient.ts:1074
Parameters
- messageId: string
- popReceipt: string
- message: string
- Optional visibilityTimeout: undefined | number
- Default value options: QueueUpdateMessageOptions = {}
Returns Promise<QueueUpdateMessageResponse>

Response data for the update message operation.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

connectionString: string

queueName: string

Optional options: StoragePipelineOptions

Returns QueueClient

Parameters

url: string

Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: StoragePipelineOptions

Returns QueueClient

Parameters

url: string

pipeline: Pipeline

Returns QueueClient

Properties

accountName

Protected storageClientContext

url

Accessors

name

Methods

clearMessages

Parameters

Default value options: QueueClearMessagesOptions = {}

Returns Promise<QueueClearMessagesResponse>

create

Parameters

Default value options: QueueCreateOptions = {}

Returns Promise<QueueCreateResponse>

delete

Parameters

Default value options: QueueDeleteOptions = {}

Returns Promise<QueueDeleteResponse>

deleteMessage

Parameters

messageId: string

popReceipt: string

Default value options: QueueDeleteMessageOptions = {}

Returns Promise<QueueDeleteMessageResponse>

getAccessPolicy

Parameters

Default value options: QueueGetAccessPolicyOptions = {}

Returns Promise<QueueGetAccessPolicyResponse>

getProperties

Parameters

Default value options: QueueGetPropertiesOptions = {}

Returns Promise<QueueGetPropertiesResponse>

peekMessages

Parameters

Default value options: QueuePeekMessagesOptions = {}

Returns Promise<QueuePeekMessagesResponse>

receiveMessages

Parameters

Default value options: QueueReceiveMessageOptions = {}

Returns Promise<QueueReceiveMessageResponse>

sendMessage

Parameters

messageText: string

Default value options: QueueSendMessageOptions = {}

Returns Promise<QueueSendMessageResponse>

setAccessPolicy

Parameters

Optional queueAcl: SignedIdentifier[]

Default value options: QueueSetAccessPolicyOptions = {}

Returns Promise<QueueSetAccessPolicyResponse>

setMetadata

Parameters

Optional metadata: Metadata

Default value options: QueueSetMetadataOptions = {}

Returns Promise<QueueSetMetadataResponse>

updateMessage

Parameters