Click or drag to resize

Notification Class

Represents a notification rule specifying when and how notifications must be sent.
Inheritance Hierarchy

Namespace:  Packflow.Modeling
Assembly:  MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax
C#
public class Notification : ModelingObject_Extended

The Notification type exposes the following members.

Constructors
  NameDescription
Public methodNotification
Initializes a new instance of the Notification class.
Top
Properties
  NameDescription
Public propertyAllStates
Gets or sets a value indicating whether all states are concerned by this trigger, when the Type is set to StateEntry.
Public propertyAllTransitions
Gets or sets a value indicating whether all transitions are concerned by this trigger, when the Type is set to TransitionPassage or TaskAssigned.
Public propertyColumns
Gets or sets the columns used to find users to notify.

Note : keys are content-type ids, and values are column ids.

Used when the NotifiedUsersScope is set to Custom.

Public propertyCustomEventName
Gets or sets a custom event name, used when the type is set to Custom.
Public propertyGuid
Gets the GUID identifying this object.
(Inherited from ModelingObject.)
Public propertyId
Gets the id identifying this object.
(Inherited from ModelingObject.)
Public propertyInstanceGuid
Gets a guid, unique for this object instance.
(Inherited from ModelingObject.)
Public propertyInstanceLanguage
Gets or sets the instance language (two letters format).
(Inherited from ModelingObject.)
Public propertyIsExtended
Gets a value indicating whether this object is Extended (ModelingObject_Extended) or not, allowing to avoid an "is" verification.
(Inherited from ModelingObject_Extended.)
Public propertyLogInEvents
Gets or sets a value indicating whether an event entry must be added in the item events when this triggers.
Public propertyMessageId
Gets or sets the id of the ContentMessage that must be sent.
Public propertyMessageMode
Gets or sets a value indicating whether the sent message is standard or custom.
Public propertyModel
Gets the model hosting this object. The Model is the root object of the modeling tree.
(Inherited from ModelingObject.)
Public propertyName
Gets the name of this object.
(Inherited from ModelingObject.)
Public propertyNotificationSystem
Gets or sets the system used to send notifications.
Public propertyNotifiedUsersScope
Gets or sets which kind of objects is used to find users to notify.
Public propertyParent
Gets the parent object in the modeling tree.
(Inherited from ModelingObject.)
Public propertyParentContentType
Gets the parent content-type.
Public propertyParentType
Gets the type of the parent object in the modeling tree.
(Inherited from ModelingObject.)
Public propertyPrivilegeKey
Gets or sets the key of the privilege used to find users to notify.

Used when the NotifiedUsersScope is set to Privilege.

Public propertyPrivilegeScope
Gets or sets which parts of the privilege permissions must be considered.

Used when the NotifiedUsersScope is set to Privilege.

Public propertyRoles
Gets or sets the roles used to find users to notify.

Used when the NotifiedUsersScope is set to Custom.

Public propertyStates
Gets or sets the states concerned by this trigger, when the Type is set to StateEntry.
Public propertyTransitions
Gets or sets the transitions concerned by this trigger, when the Type is set to TransitionPassage or TaskAssigned.
Public propertyTransitionStart
Gets or sets a value indicating whether the "first state transition" is concerned by this trigger, when the Type is set to TransitionPassage or TaskAssigned.
Public propertyType
Gets or sets the type of event triggering notifications.
Top
Methods
  NameDescription
Public methodChildren
Returns all children objects.
(Inherited from ModelingObject.)
Public methodGetGuid
Gets the Guid.
(Inherited from ModelingObject.)
Public methodGetListItem
Gets a text representing this object using Id and Name.
(Inherited from ModelingObject.)
Public methodGetMessage
Tries to get the message with id MessageId.
Public methodGetName
Gets the name.
(Inherited from ModelingObject.)
Public methodGetParentParentType
Returns the first parent of a given type in the modeling tree. Returns null if not found.
(Inherited from ModelingObject.)
Public methodGetPrivilege
Tries to get the privilege with key PrivilegeKey.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsT
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.)
Public Extension MethodEqualsAll
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.)
Public Extension MethodEqualsAny
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.)
Public Extension MethodGetString
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.)
Public Extension MethodIsGenericListOverloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericList(Type)Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.)
Public Extension MethodSerializeOverloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerialize(String)Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerializeJsonOverloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(ListType)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(DataContractJsonSerializerSettings)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Top
See Also