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
    System.Object
    SharePointRemoteEventAdapter
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace:AzureFunctionsForSharePoint.Common
    Assembly:AzureFunctionsForSharePoint.Common.dll
    Syntax
    public class SharePointRemoteEventAdapter

    Fields

    | Improve this Doc View Source

    EventProperties

    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>
    | Improve this Doc View Source

    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>
    | Improve this Doc View Source

    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 Source

    CorrelationId

    Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.CorrelationId

    Declaration
    public string CorrelationId { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    CultureLCID

    Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.CultureLCID

    Declaration
    public string CultureLCID { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    ErrorCode

    Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.ErrorCode

    Declaration
    public string ErrorCode { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    ErrorMessage

    Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.ErrorMessage

    Declaration
    public string ErrorMessage { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    EventType

    Corresponds to Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties.EventType

    Declaration
    public string EventType { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    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 Source

    GetContextToken()

    Provides the context token from the event

    Declaration
    public string GetContextToken()
    Returns
    Type Description
    System.String
    | Improve this Doc View Source

    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

    See Also

    Microsoft.SharePoint.Client.EventReceivers.SPRemoteEventProperties