Struct MacroRuleMetadata

Namespace

CMS.ContactManagement

Assembly

CMS.ContactManagement.dll

Metadata for a MacroRule in Online Marketing context. See MacroRuleMetadataContainer for information on how to use it to speed up recalculation of contact groups.

public struct MacroRuleMetadata

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

MacroRuleMetadata(string, IMacroRuleInstanceTranslator, IList<string>, IList<string>)

Constructor.

public MacroRuleMetadata(string macroRuleName, IMacroRuleInstanceTranslator translator, IList<string> affectingActivities, IList<string> affectingAttributes)

Parameters

macroRuleName string

Rule of the macro (see MacroRuleName)

translator IMacroRuleInstanceTranslator

A translator to use for macro with name macroRuleName

affectingActivities IList<string>

List of activities that affect this macro rule. The rule gets recalculated only if one of these activity types performs. Leave null to not recalculate the rule on any activity.

affectingAttributes IList<string>

List of attributes that affect this macro rule. The rule gets recalculated only if one of these attributes changes. Leave null to not recalculate the rule on any attribute change.

Fields

ALL_ACTIVITIES

A constant representing all activities. Is used in AffectingActivities to mark that all activities affect this macro rule.

public static string ALL_ACTIVITIES

Field Value

string

ALL_ATTRIBUTES

A constant representing all attributes. Is used in AffectingAttributes to mark that all attributes affect this macro rule.

public static string ALL_ATTRIBUTES

Field Value

string

AffectingActivities

Activities that affect given macro rule (that means if any of these activities performs, the rule should be recalculated).

public readonly IList<string> AffectingActivities

Field Value

IList<string>

AffectingAttributes

Determines whether the macro rule is affected by change of contact's attribute.

public readonly IList<string> AffectingAttributes

Field Value

IList<string>

MacroRuleName

Codename of the MacroRuleInfo.

public readonly string MacroRuleName

Field Value

string

Translator

A translator to use for MacroRuleInfo with MacroRuleName.

public readonly IMacroRuleInstanceTranslator Translator

Field Value

IMacroRuleInstanceTranslator

mAllActivitiesList

List with ALL_ACTIVITIES to mark that the rule should be recalculated on every activity.

public static ReadOnlyCollection<string> mAllActivitiesList

Field Value

ReadOnlyCollection<string>