Class Inx_Api_TriggerMailing_Descriptor_TimeTriggerUnit

Description

The Inx_Api_TriggerMailing_Descriptor_TimeTriggerUnit enumeration defines the time units which can be used with time triggers, including the minimum and maximum values. of time triggers, for example in offsets and intervals.

The Inx_Api_TriggerMailing_Descriptor_TimeTriggerUnit enumeration defines the time units which can be used with time triggers, including the minimum and maximum values. The TimeTriggerUnit is used in various aspects of time triggers, for example in offsets and intervals. 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.

  • author: chge, 16.07.2012
  • since: API 1.10.0

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


	
			
Method Summary
Methods
static method byId (line 176)

Returns the TimeTriggerUnit corresponding to the given ID. will be used.

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

  • return: the TimeTriggerUnit corresponding to the given ID.
  • access: public
  • int $iId: the ID of the
static method DAY (line 45)

Time unit for daily fired time triggers and offsets.

Time unit for daily fired time triggers and offsets. The values may range from 1 to 364 inclusively.

  • return: the day TimeTriggerUnit.
  • access: public
static method HOUR (line 97)

Time unit for hourly fired time triggers and offsets.

Time unit for hourly fired time triggers and offsets. The values may range from 1 to 23 inclusively.

  • return: the hour TimeTriggerUnit.
  • access: public
static method MONTH (line 58)

Time unit for monthly fired time triggers and offsets.

Time unit for monthly fired time triggers and offsets. The values may range from 1 to 12 inclusively.

  • return: the month TimeTriggerUnit.
  • access: public
static method UNKNOWN (line 111)

Unknown time unit.

Unknown time unit. Indicates a version mismatch between API and server.

  • return: the unknown TimeTriggerUnit.
  • access: public
static method values (line 194)

Returns an array containing all available TimeTriggerUnits including UNKNOWN.

Returns an array containing all available TimeTriggerUnits including UNKNOWN.

  • return: an array containing all available TimeTriggerUnits including UNKNOWN.
  • access: public
static array values ()
static method WEEK (line 84)

Time unit for weekly fired time triggers and offsets.

Time unit for weekly fired time triggers and offsets. The values may range from 1 to 51 inclusively.

  • return: the week TimeTriggerUnit.
  • access: public
static method YEAR (line 71)

Time unit for yearly fired time triggers and offsets.

Time unit for yearly fired time triggers and offsets. The values may range from 1 to 100 inclusively.

  • return: the year TimeTriggerUnit.
  • access: public
getId (line 140)

Returns the ID of the TimeTriggerUnit. used inside client code.

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

  • return: the ID of the TimeTriggerUnit.
  • access: public
int getId ()
getMaxValue (line 162)

Returns the maximum value for this TimeTriggerUnit inclusively.

Returns the maximum value for this TimeTriggerUnit inclusively.

  • return: the maximum value.
  • access: public
int getMaxValue ()
getMinValue (line 151)

Returns the minimum value for this TimeTriggerUnit inclusively.

Returns the minimum value for this TimeTriggerUnit inclusively.

  • return: the minimum value.
  • access: public
int getMinValue ()

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