RemoteExecutionContext Class

Definition

Defines the contextual information sent to a remote service endpoint at run-time.

public ref class RemoteExecutionContext sealed : Microsoft::Xrm::Sdk::IPluginExecutionContext, System::Runtime::Serialization::IExtensibleDataObject
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
[System.Runtime.Serialization.KnownType("GetKnownParameterTypes")]
public sealed class RemoteExecutionContext : Microsoft.Xrm.Sdk.IPluginExecutionContext, System.Runtime.Serialization.IExtensibleDataObject
type RemoteExecutionContext = class
    interface IPluginExecutionContext
    interface IExecutionContext
    interface IExtensibleDataObject
Public NotInheritable Class RemoteExecutionContext
Implements IExtensibleDataObject, IPluginExecutionContext
Inheritance
RemoteExecutionContext
Attributes
Implements

Remarks

A populated RemoteExecutionContext instance is passed from Microsoft Dynamics 365 to a Microsoft Azure Service Bus solution listener. The remote execution context contains the same information that is passed to an asynchronous registered Microsoft Dynamics 365 plug-in plus some additional information.

Constructors

RemoteExecutionContext()

Initializes a new instance of the RemoteExecutionContext class.

Properties

BusinessUnitId

Gets the global unique identifier of the business unit that the entity currently being processed by the event execution pipeline belongs to.

CorrelationId

Gets the global unique identifier for tracking plug-in execution.

Depth

Gets the current depth of execution in the call stack.

ExtensionData

A structure that contains extra data.

InitiatingUserAzureActiveDirectoryObjectId
InitiatingUserId

Gets the global unique identifier of the system user account under which the current pipeline is executing.

InputParameters

Gets the parameters of the request message that triggered the event that caused the plug-in to execute.

IsExecutingOffline

Gets a value indicating if the plug-in is executing from the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client while it is offline.

IsInTransaction

Gets a value indicating if the plug-in is executing within the database transaction.

IsOfflinePlayback

Gets a value indicating if the plug-in is executing as a result of the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client transitioning from offline to online and synchronizing with the Microsoft Dynamics 365 server.

IsolationMode

Gets a value indicating if the plug-in is executing in the sandbox.

MessageName

Gets the name of the Web service message that is being processed by the event execution pipeline.

Mode

Gets the mode of plug-in execution.

OperationCreatedOn

Gets the date and time that the related System Job was created.

OperationId

Gets the global unique identifier of the related System Job.

OrganizationId

Gets the global unique identifier of the organization that the entity belongs to and the plug-in executes under.

OrganizationName

Gets the unique name of the organization that the entity currently being processed belongs to and the plug-in executes under.

OutputParameters

Gets the parameters of the response message after the core platform operation has completed.

OwningExtension

Gets a reference to the related SdkMessageProcessingingStep or ServiceEndpoint.

ParentContext

Gets the remote execution context from the parent operation.

PostEntityImages

Gets the properties of the primary entity after the core platform operation has been completed.

PreEntityImages

Gets the properties of the primary entity before the core platform operation has begins.

PrimaryEntityId

Gets the global unique identifier of the primary entity for which the pipeline is processing events.

PrimaryEntityName

Gets the name of the primary entity for which the pipeline is processing events.

RequestId

Gets the global unique identifier of the request being processed by the event execution pipeline.

SecondaryEntityName

Gets the name of the secondary entity that has a relationship with the primary entity.

SharedVariables

Gets the custom properties that are shared between plug-ins.

Stage

Gets the stage in the execution pipeline that a synchronous plug-in is registered for.

UserAzureActiveDirectoryObjectId
UserId

Gets the global unique identifier of the system user for whom the plug-in invokes Web service methods on behalf of.

Explicit Interface Implementations

IPluginExecutionContext.ParentContext

For internal use only.

Extension Methods

IsAutoTransact(IPluginExecutionContext)
IsWithinMainTransaction(IPluginExecutionContext)

Applies to

See also