RemoteExecutionContext Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

Namespace:   Microsoft.Xrm.Sdk
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.RemoteExecutionContext

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/xrm/2011/Contracts")]
[KnownTypeAttribute("GetKnownParameterTypes")]
public sealed class RemoteExecutionContext : IPluginExecutionContext, 
    IExecutionContext, IExtensibleDataObject
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/xrm/2011/Contracts")>
<KnownTypeAttribute("GetKnownParameterTypes")>
Public NotInheritable Class RemoteExecutionContext
    Implements IPluginExecutionContext, IExecutionContext, IExtensibleDataObject

Constructors

Name Description
System_CAPS_pubmethod RemoteExecutionContext()

Initializes a new instance of the RemoteExecutionContext class.

Properties

Name Description
System_CAPS_pubproperty BusinessUnitId

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

System_CAPS_pubproperty CorrelationId

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

System_CAPS_pubproperty Depth

Gets the current depth of execution in the call stack.

System_CAPS_pubproperty ExtensionData

A structure that contains extra data.

System_CAPS_pubproperty InitiatingUserId

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

System_CAPS_pubproperty InputParameters

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

System_CAPS_pubproperty 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.

System_CAPS_pubproperty IsInTransaction

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

System_CAPS_pubproperty 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.

System_CAPS_pubproperty IsolationMode

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

System_CAPS_pubproperty MessageName

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

System_CAPS_pubproperty Mode

Gets the mode of plug-in execution.

System_CAPS_pubproperty OperationCreatedOn

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

System_CAPS_pubproperty OperationId

Gets the global unique identifier of the related System Job.

System_CAPS_pubproperty OrganizationId

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

System_CAPS_pubproperty OrganizationName

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

System_CAPS_pubproperty OutputParameters

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

System_CAPS_pubproperty OwningExtension

Gets a reference to the related SdkMessageProcessingingStep or ServiceEndpoint.

System_CAPS_pubproperty ParentContext

Gets the remote execution context from the parent operation.

System_CAPS_pubproperty PostEntityImages

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

System_CAPS_pubproperty PreEntityImages

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

System_CAPS_pubproperty PrimaryEntityId

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

System_CAPS_pubproperty PrimaryEntityName

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

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty SecondaryEntityName

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

System_CAPS_pubproperty SharedVariables

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

System_CAPS_pubproperty Stage

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

System_CAPS_pubproperty UserId

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

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privproperty IPluginExecutionContext.ParentContext

For internal use only.

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.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

IPluginExecutionContext
Microsoft.Xrm.Sdk Namespace
Write a listener application for a Microsoft Azure solution

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright