Interface Inx_Api_TriggerMailing_Descriptor_TimeTriggerDescriptorBuilder

Description

The Inx_Api_TriggerMailing_Descriptor_TimeTriggerDescriptorBuilder builder is used to easily create time triggers.

The Inx_Api_TriggerMailing_Descriptor_TimeTriggerDescriptorBuilder builder is used to easily create time triggers. There are only two mandatory settings: the start date and the sending time which identify the date and time at which the trigger will be fired for the first time. The following settings are optional:

  • The end date: Defines the date at which the trigger mailing will be dispatched for the last time.
  • The attribute value setters: Can be used to set recipient attribute values along with the dispatch of the trigger mailing.

  • author: chge, 16.07.2012
  • since: API 1.10.0

Located in /Api/TriggerMailing/Descriptor/TimeTriggerDescriptorBuilder.php (line 23)

Inx_Api_TriggerMailing_Descriptor_TriggerDescriptorBuilder
   |
   --Inx_Api_TriggerMailing_Descriptor_TimeTriggerDescriptorBuilder
Direct descendents
Class Description
Inx_Api_TriggerMailing_Descriptor_AttributeTriggerDescriptorBuilder The Inx_Api_TriggerMailing_Descriptor_AttributeTriggerDescriptorBuilder is used to easily create attribute driven time triggers.
Inx_Api_TriggerMailing_Descriptor_IntervalTriggerDescriptorBuilder The Inx_Api_TriggerMailing_Descriptor_IntervalTriggerDescriptorBuilder is used to easily create interval triggers.
Method Summary
Methods
attributeValueSetters (line 90)

Sets an array of Inx_Api_Action_SetValueCommands which will be executed when dispatching the trigger mailings. of a trigger mailing to that same recipient.

Sets 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 optional.

  • return: the builder.
  • access: public
Inx_Api_TriggerMailing_Descriptor_TimeTriggerDescriptorBuilder attributeValueSetters ([ $commands = null])
  • array $commands: an array of Inx_Api_Action_SetValueCommands used to set recipient attributes during dispatch.
endDate (line 78)

Sets the date at which the trigger will be fired for the last time. time component of the date will be disregarded. method. will be set to zero.

Sets the date at which the trigger will be fired for the last time. This setting is optional. Be aware that the time component of the date will be disregarded. The sending time is specified separately by the sendingTime method. The time component of the specified date will be overwritten accordingly. Also, the seconds and milliseconds will be set to zero. For example, consider the following two dates for end date and sending time:

  • End date: 2015-01-01T13:57:04+01:00
  • Sending time: 2012-07-05T12:30:42+01:00
The resulting end date for the trigger will be: 2015-01-01T12:30:00+01:00

  • return: the builder.
  • access: public
  • string $sEndDate: the date at which the trigger will be fired for the last time. The date has to be specified as ISO-8601 formatted date or datetime string.
sendingTime (line 58)

Sets the time at which the sending will be started during each dispatch cycle. aware that the date component of the given date object will be disregarded. will be set to zero. TriggerDescriptor is built.

Sets the time at which the sending will be started during each dispatch cycle. This setting is mandatory. Be aware that the date component of the given date object will be disregarded. Also, the seconds and milliseconds will be set to zero. This setting will overwrite the time component of the start and end dates when the TriggerDescriptor is built.

  • return: the builder.
  • throws: Inx_Api_NullPointerException if the given sending time is null.
  • access: public
  • string $sSendingTime: the time at which the sending will be started during each dispatch cycle. The date has to be specified as ISO-8601 formatted time or datetime string.
startDate (line 44)

Sets the date at which the trigger will be fired for the first time. time component of the date will be disregarded. method. will be set to zero.

Sets the date at which the trigger will be fired for the first time. This setting is mandatory. Be aware that the time component of the date will be disregarded. The sending time is specified separately by the sendingTime method. The time component of the specified date will be overwritten accordingly. Also, the seconds and milliseconds will be set to zero. For example, consider the following two dates for start date and sending time:

  • Start date: 2013-01-01T13:57:04+01:00
  • Sending time: 2012-07-05T12:30:42+01:00
The resulting start date for the trigger will be: 2013-01-01T12:30:00+01:00

  • return: the builder.
  • throws: Inx_Api_NullPointerException if the given start date is null.
  • access: public
  • string $sStartDate: the date at which the trigger will be fired for the first time. The date has to be specified as ISO-8601 formatted date or datetime string.

Inherited Methods

Inherited From Inx_Api_TriggerMailing_Descriptor_TriggerDescriptorBuilder

Inx_Api_TriggerMailing_Descriptor_TriggerDescriptorBuilder::build()
Inx_Api_TriggerMailing_Descriptor_TriggerDescriptorBuilder::validate()

Documentation generated on Thu, 17 Sep 2015 14:27:32 +0200 by phpDocumentor 1.3.2