Class Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchInterval

Description

The Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchInterval enumeration defines the possible interval types of interval trigger mailings.

The Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchInterval enumeration defines the possible interval types of interval trigger mailings. A note for programmers who are not familiar with the concept of enumerations: Enumerations or enumerated types are basically a fixed set of named values. They are usually used to define a couple of legitimate values in a specific context and serve a purpose similar to integer constants. The advantage of enumerations is, that you cannot specify any "weird" values because every value has to be an instance of the enumerated type. It is also possible to associate data or even behaviour (methods) with the values. PHP does not support such a language feature like Java and C# do. In most languages the named values are a sort of constant whose value is an instance of the enumerated type. In PHP a constant cannot contain a reference type. Therefore, we implemented enumerations as classes with private constructor and methods which return the named values. Be aware that the objects returned by the static methods are always the same object. That way it is possible to use the identity operator (===) on these objects and use them comfortably in switch statements.

Located in /Api/TriggerMailing/Descriptor/TimeTriggerDispatchInterval.php (line 26)


	
			
Method Summary
Methods
static method byId (line 259)

Returns the TimeTriggerDispatchInterval corresponding to the given ID. UNKNOWN interval will be used. code.

Returns the TimeTriggerDispatchInterval corresponding to the given ID. If the ID is unknown, the UNKNOWN interval will be used. The ID is used for transmission purposes and should not be used inside client code.

  • return: the TimeTriggerDispatchInterval corresponding to the given ID.
  • access: public
  • int $iId: the ID of the TimeTriggerDispatchInterval to retrieve.
static method DAILY (line 195)

Dispatch interval for time triggers which fire on a daily basis.

Dispatch interval for time triggers which fire on a daily basis.

  • return: the daily TimeTriggerDispatchInterval.
  • access: public
static method FRIDAY (line 156)

Dispatch interval for time triggers which fire on every Friday.

Dispatch interval for time triggers which fire on every Friday.

  • return: the friday TimeTriggerDispatchInterval.
  • access: public
static method HOURLY (line 208)

Dispatch interval for time triggers which fire on a hourly basis.

Dispatch interval for time triggers which fire on a hourly basis.

  • return: the hourly TimeTriggerDispatchInterval.
  • access: public
static method LAST_DAY_OF_MONTH (line 60)

Dispatch interval for time triggers which fire on the last day of each month.

Dispatch interval for time triggers which fire on the last day of each month.

  • return: the last day of month TimeTriggerDispatchInterval.
  • access: public
static method MONDAY (line 104)

Dispatch interval for time triggers which fire on every Monday.

Dispatch interval for time triggers which fire on every Monday.

  • return: the monday TimeTriggerDispatchInterval.
  • access: public
static method SATURDAY (line 169)

Dispatch interval for time triggers which fire on every Saturday.

Dispatch interval for time triggers which fire on every Saturday.

  • return: the saturday TimeTriggerDispatchInterval.
  • access: public
static method SPECIFIC_DAY_BEFORE_END_OF_MONTH (line 90)

Dispatch interval for time triggers which fire on a specific day before the end of each month.

Dispatch interval for time triggers which fire on a specific day before the end of each month.

  • return: the specific day before end of month TimeTriggerDispatchInterval.
  • access: public
static Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchInterval SPECIFIC_DAY_BEFORE_END_OF_MONTH ()
static method SPECIFIC_DAY_OF_MONTH (line 75)

Dispatch interval for time triggers which fire on a specific day of each month.

Dispatch interval for time triggers which fire on a specific day of each month.

  • return: the specific day of month TimeTriggerDispatchInterval.
  • access: public
static method SUNDAY (line 182)

Dispatch interval for time triggers which fire on every Sunday.

Dispatch interval for time triggers which fire on every Sunday.

  • return: the sunday TimeTriggerDispatchInterval.
  • access: public
static method THURSDAY (line 143)

Dispatch interval for time triggers which fire on every Thursday.

Dispatch interval for time triggers which fire on every Thursday.

  • return: the thursday TimeTriggerDispatchInterval.
  • access: public
static method TUESDAY (line 117)

Dispatch interval for time triggers which fire on every Tuesday.

Dispatch interval for time triggers which fire on every Tuesday.

  • return: the tuesday TimeTriggerDispatchInterval.
  • access: public
static method UNKNOWN (line 221)

Unknown dispatch interval.

Unknown dispatch interval. Indicates a version mismatch between API and server.

  • return: the unknown TimeTriggerDispatchInterval.
  • access: public
static method values (line 277)

Returns an array containing all available TimeTriggerDispatchIntervals including UNKNOWN.

Returns an array containing all available TimeTriggerDispatchIntervals including UNKNOWN.

  • return: an array containing all available TimeTriggerDispatchIntervals including UNKNOWN.
  • access: public
static array values ()
static method WEDNESDAY (line 130)

Dispatch interval for time triggers which fire on every Wednesday.

Dispatch interval for time triggers which fire on every Wednesday.

  • return: the wednesday TimeTriggerDispatchInterval.
  • access: public
getId (line 244)

Returns the ID of the TimeTriggerDispatchInterval. should not be used inside client code.

Returns the ID of the TimeTriggerDispatchInterval. The ID is used for transmission purposes and should not be used inside client code.

  • return: the ID of the TimeTriggerDispatchInterval.
  • access: public
int getId ()

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