Class SharePointRemoteEventAdapter
Represents a remote SharePoint event notification parsed to be easy to handle with additional context to augment event processing. Sent by the EventDispatch function to a client's service bus queue in response to receipt of a remote event notification
Inheritance
Inherited Members
Namespace:AzureFunctionsForSharePoint.Common
Assembly:AzureFunctionsForSharePoint.Common.dll
Syntax
public class SharePointRemoteEventAdapter
Fields
| Improve this Doc View SourceEventProperties
Name value pairs of the event data provided with the remote event. These vary by event types.
Declaration
public Dictionary<string, string> EventProperties
Field Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, System.String> |
ItemAfterProperties
If applicable and available, the properties of a list item after the event
Declaration
public Dictionary<string, string> ItemAfterProperties
Field Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, System.String> |
ItemBeforeProperties
If applicable and available, the properties of a list item before the event. Event dispatch attempts to augment this data when possible.
Declaration
public Dictionary<string, string> ItemBeforeProperties
Field Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, System.String> |
Properties
| Improve this Doc View SourceCorrelationId
Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.CorrelationId
Declaration
public string CorrelationId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CultureLCID
Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.CultureLCID
Declaration
public string CultureLCID { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ErrorCode
Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.ErrorCode
Declaration
public string ErrorCode { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ErrorMessage
Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.ErrorMessage
Declaration
public string ErrorMessage { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EventType
Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.EventType
Declaration
public string EventType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
UICultureLCID
Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.UICultureLCID
Declaration
public string UICultureLCID { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
| Improve this Doc View SourceGetContextToken()
Provides the context token from the event
Declaration
public string GetContextToken()
Returns
Type | Description |
---|---|
System.String |
GetSharePointRemoteEventAdapter(String)
Transforms the text of a remote event WCF SOAP message into a new SharePointRemoteEventAdapter
Declaration
public static SharePointRemoteEventAdapter GetSharePointRemoteEventAdapter(string soapBody)
Parameters
Type | Name | Description |
---|---|---|
System.String | soapBody | Message received from SharePoint |
Returns
Type | Description |
---|---|
SharePointRemoteEventAdapter | A new SharePointRemoteEventAdapter instance from the SOAP message |