Class Inx_Api_TriggerMailing_Descriptor_TriggerType

Description

The Inx_Api_TriggerMailing_Descriptor_TriggerType enumeration defines the different types of triggers. trigger types can be divided into two categories:

The Inx_Api_TriggerMailing_Descriptor_TriggerType enumeration defines the different types of triggers. The trigger types can be divided into two categories:

  1. Time triggers: Used for time controlled dispatch of trigger mailings.
  2. Action triggers: Used for action controlled dispatch of trigger mailings.
Time trigger mailings are sent out on a regular basis. The following time triggers are available:

  • Birthday: A mailing of this type is sent to recipients on the annual recurrence of a specific date. A datetime attribute of the recipient acts as a baseline and the mailing is sent every year after this baseline. An offset can be specified to send the mailing some time before or after the annual recurrence. The condition is checked once a day. The birthday trigger is an attribute driven time trigger.
  • Anniversary: A mailing of this type is sent to recipients on the recurrence of a specific date. A datetime attribute of the recipient acts as baseline and the mailing is sent after a user defined period of time (years, months or days) after this baseline. An offset can be specified to send the mailing some time before or after the recurrence. The condition is checked once a day. The anniversary trigger is an attribute driven time trigger.
  • Reminder: A mailing of this type is sent to recipients on a specific date. A datetime attribute of the recipient defines that date. An offset can be specified to send the mailing some time before the date. The condition is checked once a day. The reminder trigger is an attribute driven time trigger.
  • Follow up: A mailing of this type is sent to recipients on a specific date. A datetime attribute of the recipient defines that date. An offset can be specified to send the mailing some time after the date. The condition is checked once a day. The follow up trigger is an attribute driven time trigger.
  • Interval: A mailing of this type is sent to all recipients of the associated list at a freely definable interval (i.e. hourly, daily, weekly,...). The interval is described by an Inx_Api_TriggerMailing_Descriptor_TriggerInterval object. The interval trigger is a time trigger which is not related to a specific attribute.

Action trigger mailings, on the other hand, are only sent if the associated action is executed. Be aware that the action cannot be defined by the trigger descriptor. Instead, the action contains a command (an Inx_Api_Action_SendMailCommand) which will send the mailing.

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/TriggerType.php (line 56)


	
			
Method Summary
Methods
static method ACTION_MAILING (line 79)

Type constant for action mailings. Inx_Api_Action_SendMailCommand.

Type constant for action mailings. An action mailing is sent by the associated action using an Inx_Api_Action_SendMailCommand.

static method byTypeId (line 229)

Returns the TriggerType corresponding to the given ID. be used.

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

  • return: the TriggerType corresponding to the given ID.
  • access: public
static Inx_Api_TriggerMailing_Descriptor_TriggerType byTypeId (int $iId)
  • int $iId: the ID of the TriggerType to retrieve.
static method TIME_TRIGGER_ANNIVERSARY_MAILING (line 124)

Type constant for anniversary trigger mailings. for which the day of the attribute matches the current day and was a fixed number of years, months or days ago.

Type constant for anniversary trigger mailings. An anniversary trigger mailing is sent every day to recipients for which the day of the attribute matches the current day and was a fixed number of years, months or days ago. The anniversary trigger is an attribute driven time trigger.

  • return: the anniversary TriggerType.
  • access: public
static Inx_Api_TriggerMailing_Descriptor_TriggerType TIME_TRIGGER_ANNIVERSARY_MAILING ()
static method TIME_TRIGGER_BIRTHDAY_MAILING (line 109)

Type constant for birthday trigger mailings. the day of the attribute matches the current day.

Type constant for birthday trigger mailings. A birthday trigger mailing is sent every day to recipients for which the day of the attribute matches the current day. The birthday trigger is an attribute driven time trigger.

  • return: the birthday TriggerType.
  • access: public
static Inx_Api_TriggerMailing_Descriptor_TriggerType TIME_TRIGGER_BIRTHDAY_MAILING ()
static method TIME_TRIGGER_FOLLOW_UP_MAILING (line 154)

Type constant for follow up trigger mailing. which the date in the attribute matches the current date (only negative offset). attribute driven time trigger.

Type constant for follow up trigger mailing. A follow up trigger mailing is sent every day to recipients for which the date in the attribute matches the current date (only negative offset). the follow up trigger is an attribute driven time trigger.

  • return: the follow-up TriggerType.
  • access: public
static Inx_Api_TriggerMailing_Descriptor_TriggerType TIME_TRIGGER_FOLLOW_UP_MAILING ()
static method TIME_TRIGGER_INTERVAL_MAILING (line 95)

Type constant for interval trigger mailings. associated list at a freely definable interval (e. TriggerInterval.

Type constant for interval trigger mailings. An interval trigger mailing is sent to all recipients in the associated list at a freely definable interval (e.g. hourly, daily, weekly,...). The interval is described by a TriggerInterval. The interval trigger is a time trigger but no attribute driven trigger.

  • return: the interval TriggerType.
  • see: com.inxmail.xpro.api.triggermailing.descriptor.TriggerInterval
  • access: public
static Inx_Api_TriggerMailing_Descriptor_TriggerType TIME_TRIGGER_INTERVAL_MAILING ()
static method TIME_TRIGGER_REMINDER_MAILING (line 139)

Type constant for reminder trigger mailings. the date in the attribute matches the current date (only positive offset). driven time trigger.

Type constant for reminder trigger mailings. A reminder trigger mailing is sent every day to recipients for which the date in the attribute matches the current date (only positive offset). The reminder trigger is an attribute driven time trigger.

  • return: the reminder TriggerType.
  • access: public
static Inx_Api_TriggerMailing_Descriptor_TriggerType TIME_TRIGGER_REMINDER_MAILING ()
static method UNKNOWN (line 167)

Type constant for an unknown trigger type.

Type constant for an unknown trigger type. Indicates a version mismatch between API and server.

  • return: the unknown TriggerType.
  • access: public
static method values (line 247)

Returns an array containing all available TriggerTypes including UNKNOWN.

Returns an array containing all available TriggerTypes including UNKNOWN.

  • return: an array containing all available TriggerTypes including UNKNOWN.
  • access: public
static array values ()
getTypeId (line 190)

Returns the ID of the TriggerType. inside client code.

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

  • return: the ID of the TriggerType.
  • access: public
int getTypeId ()
isAttributeTriggerType (line 215)

Returns a bool indicating whether the TriggerType is an attribute driven trigger type.

Returns a bool indicating whether the TriggerType is an attribute driven trigger type.

  • return: if the TriggerType is an attribute driven trigger type, icode>false</i> otherwise.
  • access: public
true isAttributeTriggerType ()
isTimeTriggerType (line 201)

Returns a bool indicating whether the TriggerType is a time trigger type.

Returns a bool indicating whether the TriggerType is a time trigger type.

  • return: if the TriggerType is a time trigger type, false otherwise.
  • access: public
true isTimeTriggerType ()

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