Interface Inx_Api_TriggerMailing_Descriptor_TriggerInterval

Description

The Inx_Api_TriggerMailing_Descriptor_TriggerInterval is the integral part of the interval trigger. describes when the trigger will be fired using a combination of the following settings:

The Inx_Api_TriggerMailing_Descriptor_TriggerInterval is the integral part of the interval trigger. It describes when the trigger will be fired using a combination of the following settings:

  • The interval unit: Defines the unit of the interval (e.g. day, week, month,...).
  • The interval count: Defines the how many times the trigger shall be fired (e.g. every X months).
  • The dispatch intervals: Defines the dispatch intervals (e.g. daily, hourly, day in month,...).
  • The day: Defines the day on which the trigger shall be fired. Only used in combination with monthly dispatch intervals.
It's rarely advisable to create a TriggerInterval directly as the state space is complex and can be confusing. Generally, it's reasonable to use an Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilder for this task which will guide you through the process of creating a TriggerInterval and complain about any missing settings and broken invariants.

For an example on how to create a TriggerInterval using a builder, see the Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilder documentation.

Located in /Api/TriggerMailing/Descriptor/TriggerInterval.php (line 31)


	
			
Method Summary
Methods
getDayInterval (line 81)

Returns the day of the dispatch interval.

Returns the day of the dispatch interval. Do not confuse this setting with the interval count setting as they are used for different purposes. For example, to fire the trigger every two months on the first day of the month, you need the following settings:

  • Unit: Month
  • Count: 2
  • Dispatch intervals: [SPECIFIC_DAY_OF_MONTH]
  • Day: 1

  • return: the day of the dispatch interval.
  • access: public
int getDayInterval ()
getDispatchIntervals (line 65)

Returns the set (implemented as array) of Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchIntervals which determines the dispatch intervals. use.

Returns the set (implemented as array) of Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchIntervals which determines the dispatch intervals. Which dispatch intervals are legal depends on the type of trigger interval you use. The builders clearly point out which combinations are legal.

  • return: the set of Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchIntervals which determines the dispatch intervals.
  • access: public
array getDispatchIntervals ()
getIntervalCount (line 54)

Returns the interval count.

Returns the interval count. Do not confuse this setting with the day setting as they are used for different purposes. For example, to fire the trigger every two months on the first day of the month, you need the following settings:

  • Unit: Month
  • Count: 2
  • Dispatch intervals: [SPECIFIC_DAY_OF_MONTH]
  • Day: 1

  • return: the interval count.
  • access: public
int getIntervalCount ()
getIntervalUnit (line 38)

Returns the interval unit.

Returns the interval unit.

  • return: the interval unit.
  • access: public

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