PassedInSubscriptionXmlData Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

This class is used by Subscription event handlers to represent parsed event XML arguments passed in to the EventHandler(Int32, Int32, String, String, ICSCredentialsContainer, Int32, String) method implementations.
Inheritance Hierarchy

SystemObject
  ContentStudio.Document.Subscription.EventHandlerPassedXmlData
    ContentStudio.Document.Subscription.EventHandlerPassedInSubscriptionXmlData

Namespace: ContentStudio.Document.Subscription.EventHandler
Assembly: CSSubscriptionEventHandler (in CSSubscriptionEventHandler.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax

public class PassedInSubscriptionXmlData : PassedXmlData

The PassedInSubscriptionXmlData type exposes the following members.

Constructors

  NameDescription
Public methodPassedInSubscriptionXmlData
Initializes a new instance of the PassedInSubscriptionXmlData class from supplied XML data.
Top
Properties

  NameDescription
Public propertyAuthenticationSchema
Gets or sets the authentication schema to use when communicating with the sender server.
Public propertyCallerSessionId
Gets the caller session id.
(Inherited from PassedXmlData.)
Public propertyCategoryId
Gets the category id.
(Inherited from PassedXmlData.)
Public propertyDocumentId
Gets the document id.
(Inherited from PassedXmlData.)
Public propertyDocumentName
Gets the name of the document.
(Inherited from PassedXmlData.)
Public propertyDocumentTitle
Gets the document title.
(Inherited from PassedXmlData.)
Public propertyEncoding
Gets the encoding.
(Inherited from PassedXmlData.)
Public propertyFileName
Gets the name of the file.
(Inherited from PassedXmlData.)
Public propertyFullName
Gets the full name.
(Inherited from PassedXmlData.)
Public propertyIdentifier
Gets the identifier for this subscription definition. This property in null unless this data represents a ContentStudioEvents.OnDocumentSubscription event.
Public propertyMsgId
Gets the message identifier.
(Inherited from PassedXmlData.)
Public propertyPresentationTemplateId
Getsthe presentationtemplate used when presentation the message source document.
Public propertyReceiver
Gets the receiver. This property in null unless this data represents a ContentStudioEvents.OnTestDocumentSubscription event.
Public propertySender
Gets or sets the sender of the subscription message. For email messages this should be an email address
Public propertyServer
Gets the name or IP-number of the server to use when distributing messages.
Public propertySiteUri
Gets or sets the site URL to when the eventhandler reads the document. This value should be the base url of the site without any file names.
Public propertyTimestamp
Gets the timestamp.
(Inherited from PassedXmlData.)
Public propertyUserId
Gets the user id.
(Inherited from PassedXmlData.)
Public propertyUserName
Gets the name of the user.
(Inherited from PassedXmlData.)
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
Fields

  NameDescription
Protected fieldAdditionalProperties (Inherited from PassedXmlData.)
Top
See Also

Reference