An Inx_Api_TriggerMailing_Descriptor_TriggerDescriptor describes the trigger of an Inx_Api_TriggerMailing_TriggerMailing. which recipients will receive it. the whole dispatch process.
An Inx_Api_TriggerMailing_Descriptor_TriggerDescriptor describes the trigger of an Inx_Api_TriggerMailing_TriggerMailing. The trigger defines when a TriggerMailing will be sent and which recipients will receive it. It therefore is the most important part of a TriggerMailing, controlling the whole dispatch process. A TriggerDescriptor consists of a number of settings - some of which are optional depending on the Inx_Api_TriggerMailing_Descriptor_TriggerType. The following settings are supported:
It's rarely advisable to create a TriggerDescriptor directly as the state space is complex and can be confusing. Generally, it's reasonable to use an Inx_Api_TriggerMailing_Descriptor_TriggerDescriptorBuilder for this task which will guide you through the process of creating a TriggerDescriptor and complain about any missing settings and broken invariants.
For an example on how to create a TriggerDescriptor using a builder, see the Inx_Api_TriggerMailing_TriggerMailingManager documentation.
Located in /Api/TriggerMailing/Descriptor/TriggerDescriptor.php (line 43)
Returns the ID of the recipient attribute used as basis of the trigger described by this TriggerDescriptor.
Returns the ID of the recipient attribute used as basis of the trigger described by this TriggerDescriptor. This setting is only mandatory and relevant for all attribute driven triggers.
Returns an array of Inx_Api_Action_SetValueCommands which will be executed when dispatching the trigger mailings. of a trigger mailing to that same recipient. trigger mailings.
Returns an array of Inx_Api_Action_SetValueCommands which will be executed when dispatching the trigger mailings. Using this feature, it is possible to set the values of recipient attributes along with the dispatching of a trigger mailing to that same recipient. This setting is generally optional and only relevant for time trigger mailings.
Returns the Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffset used to define the time span between the dispatch date and the date specified by the attribute. out ten years after the date specified by the attribute. anniversary triggers.
Returns the Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffset used to define the time span between the dispatch date and the date specified by the attribute. For example: An anniversary trigger mailing can be sent out ten years after the date specified by the attribute. This setting is only mandatory and relevant for anniversary triggers.
Returns the date when the trigger described by this TriggerDescriptor will be fired for the last time.
Returns the date when the trigger described by this TriggerDescriptor will be fired for the last time. This setting is generally optional and only relevant for time trigger mailings.
Returns the Inx_Api_TriggerMailing_Descriptor_TriggerInterval used to define the dispatch intervals of an interval trigger mailing.
Returns the Inx_Api_TriggerMailing_Descriptor_TriggerInterval used to define the dispatch intervals of an interval trigger mailing. This setting is only mandatory and relevant for interval triggers.
Returns the Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffset used to alter the dispatch date specified by the attribute.
Returns the Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffset used to alter the dispatch date specified by the attribute. For example: Normally, birthday trigger mailings are sent on the birthday of the recipient. Using a TimeTriggerOffset you can send your congratulations before or after that date. This setting is generally optional and only relevant for time trigger mailings.
Returns the time when the trigger described by this TriggerDescriptor will be fired during each dispatch cycle. triggers.
Returns the time when the trigger described by this TriggerDescriptor will be fired during each dispatch cycle. This setting is mandatory for all time triggers. That is, it's mandatory for all but action triggers.
Returns the date when the trigger described by this TriggerDescriptor will be fired for the first time.
Returns the date when the trigger described by this TriggerDescriptor will be fired for the first time. This setting is mandatory for all time triggers. That is, it's mandatory for all but action triggers.
Returns the type of the trigger described by this TriggerDescriptor. mandatory.
Returns the type of the trigger described by this TriggerDescriptor. This setting is strictly mandatory.
Documentation generated on Thu, 17 Sep 2015 14:27:32 +0200 by phpDocumentor 1.3.2