ServiceBusSessionMessageActions Class

Definition

Namespace:

Microsoft.Azure.WebJobs.ServiceBus

Assembly:

Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

Package:

Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.16.4

Source:

ServiceBusSessionMessageActions.cs

Represents the set of actions that can be performed on a session and a message received from a ServiceBusReceivedMessage.

public class ServiceBusSessionMessageActions : Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions

type ServiceBusSessionMessageActions = class
    inherit ServiceBusMessageActions

Public Class ServiceBusSessionMessageActions
Inherits ServiceBusMessageActions

Inheritance

Object

ServiceBusMessageActions

ServiceBusSessionMessageActions

Constructors

ServiceBusSessionMessageActions()

Initializes a new instance of the ServiceBusSessionMessageActions class for mocking use in testing.

Properties

SessionLockedUntil

Gets the DateTimeOffset that the receiver's session is locked until.

Methods

AbandonMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	Abandons a ServiceBusReceivedMessage.This will make the message available again for immediate processing as the lock on the message held by the receiver will be released. (Inherited from ServiceBusMessageActions)
CompleteMessageAsync(ServiceBusReceivedMessage, CancellationToken)	Completes a ServiceBusReceivedMessage. This will delete the message from the service. (Inherited from ServiceBusMessageActions)
DeadLetterMessageAsync(ServiceBusReceivedMessage, Dictionary<String,Object>, String, String, CancellationToken)	Moves a message to the dead-letter subqueue. (Inherited from ServiceBusMessageActions)
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	Moves a message to the dead-letter subqueue. (Inherited from ServiceBusMessageActions)
DeadLetterMessageAsync(ServiceBusReceivedMessage, String, String, CancellationToken)	Moves a message to the dead-letter subqueue. (Inherited from ServiceBusMessageActions)
DeferMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	Indicates that the receiver wants to defer the processing for the message. (Inherited from ServiceBusMessageActions)
GetSessionStateAsync(CancellationToken)	Gets the session state.
ReleaseSession()	Releases the session that is being processed. No new receives will be initiated for the session before the session is closed. Any already received messages will still be delivered to the user message handler, and in-flight message handlers will be allowed to complete. Messages will still be completed automatically if AutoCompleteMessages is true. The session may end up being reopened for processing immediately after closing if there are messages remaining in the session ( This depends on what other session messages may be in the queue or subscription).
RenewMessageLockAsync(ServiceBusReceivedMessage, CancellationToken)	Renews the lock on the message. The lock will be renewed based on the setting specified on the queue. (Inherited from ServiceBusMessageActions)
RenewSessionLockAsync(CancellationToken)	Renews the lock on the session specified by the SessionId. The lock will be renewed based on the setting specified on the entity.
SetSessionStateAsync(BinaryData, CancellationToken)	Set a custom state on the session which can be later retrieved using GetSessionStateAsync(CancellationToken)