Share via

3.1.4.3.2.9 Message

  • Article

The Message element contains detailed information about a change as part of the SPSite change notification.<25> Message has the following schema.<26>

     <s:complexType name="Message">
       <s:sequence>
         <s:element name="Exception" minOccurs="1" maxOccurs="1" type="s:string">
         </s:element>
         <s:element name="ChangeInfo" minOccurs="1" maxOccurs="1">
          <s:complexType>
           <s:attribute name="SiteId" type="s:string" use="required" />
           <s:attribute name="WebId" type="s:string" use="optional" />
           <s:attribute name="ListId" type="s:string" use="optional" />
           <s:attribute name="AlertId" type="s:string" use="optional" />
           <s:attribute name="Id" type="s:string" use="optional" />
           <s:attribute name="FieldId" type="s:string" use="optional" />
           <s:attribute name="Url" type="s:string" use="optional" />
           <s:attribute name="DocId" type="s:string" use="optional" />
           <s:attribute name="UserId" type="s:string" use="optional" />
           <s:attribute name="Activate" type="s:boolean" use="optional" />
           <s:attribute name="IsSiteAdminChange" type="s:boolean" use="optional" />
          </s:complexType>
         </s:element>
       </s:sequence>
       <s:attribute name="ChangeToken" type="s:string" use="required" />
       <s:attribute name="ChangeObject" type="tns:ChangeObject" use="required" />
       <s:attribute name="ChangeType" type="tns:ChangeType" use="required" />
     </s:complexType>

ChangeToken: Specifies the token of the change.

ChangeObject: Specifies the type identifier of the change. See section 3.1.4.3.5.2.

ChangeType: Specifies the original type of the change before processing. See section 3.1.4.3.5.3.

Exception: Specifies details about the error that occurred while processing the change.

ChangeInfo: Specifies a core set of information about the change.

ChangeInfo.SiteId: Specifies the GUID of the site collection in which the changed item is located.

ChangeInfo.WebId: Specifies the GUID of the site in which the changed item is located. If the changed item is a site collection, this attribute MUST be omitted.

ChangeInfo.ListId: Specifies the GUID of the list in which the changed item is located. If the changed item is a site or site collection, this attribute MUST be omitted.

ChangeInfo.AlertId: If the changed item is an alert, specifies the GUID for the alert. If the changed item is not an alert, this attribute MUST be omitted.

ChangeInfo.Id: Specifies the GUID of the changed item.

ChangeInfo.FieldId: Specifies the GUID of the field that was changed. If the changed item is not a field, this attribute MUST be omitted.

ChangeInfo.Url: Specifies the URL of the changed item.

ChangeInfo.DocId: Specifies the GUID of the document representing the changed item.

ChangeInfo.UserId: Specifies the GUID of the user whose data was changed. If the changed item is not a user, this attribute MUST be omitted.

ChangeInfo.Activate: Specifies if the security change involved giving write permission to a user who previously only had read permission. If the changed item is not a security change, this attribute MUST be omitted.

ChangeInfo.IsSiteAdminChange: Specifies if the security change involved change the current site collection administrator. If the changed item is not a security change, this attribute MUST be omitted.