Class Inx_Api_TriggerMailing_TriggerMailingAttribute

Description

The TriggerMailingAttribute enumeration defines the attributes of trigger mailings which are used for the ordering of result sets and to identify the error source of an Inx_Api_UpdateException.

The TriggerMailingAttribute enumeration defines the attributes of trigger mailings which are used for the ordering of result sets and to identify the error source of an Inx_Api_UpdateException. To find out if an attribute may be used for ordering, call the isOrderAttribute() method.

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, 13.07.2012
  • see: Inx_Api_UpdateException::getErrorSource()
  • see: Inx_Api_TriggerMailing_TriggerMailingManager::selectByState( Inx_Api_List_ListContext $listContext, Inx_Api_TriggerMailing_StateFilter $stateFilter, Inx_Api_TriggerMailing_TriggerMailingAttribute $orderAttribute = null, $iOrderType = null, $sFilter = null )
  • since: API 1.10.0

Located in /Api/TriggerMailing/TriggerMailingAttribute.php (line 31)


	
			
Method Summary
static array getOrderAttributes ()
static array values ()
int getId ()
Methods
static method ACTIVATION_DATETIME (line 300)

Constant for the activation datetime attribute.

Constant for the activation datetime attribute. Used for ordering by the TriggerMailingManager

  • return: the activation datetime attribute.
  • see: Inx_Api_TriggerMailing_TriggerMailingManager::selectByState( Inx_Api_List_ListContext $listContext, Inx_Api_TriggerMailing_StateFilter $stateFilter, Inx_Api_TriggerMailing_TriggerMailingAttribute $orderAttribute = null, $iOrderType = null, $sFilter = null )
  • access: public
static Inx_Api_TriggerMailing_TriggerMailingAttribute ACTIVATION_DATETIME ()
static method byId (line 428)

Returns the TriggerMailingAttribute corresponding to the given id. UNKNOWN attribute will be returned. inside client code.

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

  • return: the TriggerMailingAttribute corresponding to the given ID.
  • access: public
  • int $iId: the ID of the TriggerMailingAttribute to retrieve.
static method DEFAULT_ATTRIBUTE (line 360)

The default attribute used for ordering and as error source if no specific attribute is known or given.

The default attribute used for ordering and as error source if no specific attribute is known or given.

  • return: the default attribute.
  • access: public
static method DESCRIPTOR (line 347)

Constant for the trigger descriptor attribute. source.

Constant for the trigger descriptor attribute. Used by the UpdateException to identify the error source.

static method FILTER_ID (line 202)

Constant for the filter id attribute.

Constant for the filter id attribute.

  • return: the filter id attribute.
  • access: public
static method getOrderAttributes (line 447)

Returns an array of the TriggerMailingAttributes which can be used for ordering.

Returns an array of the TriggerMailingAttributes which can be used for ordering.

  • return: an array of the TriggerMailingAttributes which can be used for ordering.
  • access: public
static array getOrderAttributes ()
static method HTML_TEXT (line 150)

Constant for the HTML text attribute.

Constant for the HTML text attribute.

  • return: the HTML text attribute.
  • access: public
static method HTML_TEXT_XSL (line 189)

Constant for the HTML text style XML content attribute.

Constant for the HTML text style XML content attribute.

  • return: the HTML text style XML content attribute.
  • access: public
static method INTERNAL_MAILING_CONTENT_MAIL_TYPE (line 95)

Constant for the mailing content (MIME) type attribute.

Constant for the mailing content (MIME) type attribute. This constant is used internally only.

  • return: the mailing content type attribute.
  • access: public
static Inx_Api_TriggerMailing_TriggerMailingAttribute INTERNAL_MAILING_CONTENT_MAIL_TYPE ()
static method INTERNAL_MAILING_FEATURE_ID (line 108)

Constant for the mailing feature id.

Constant for the mailing feature id. This constant is used internally only.

  • return: the mailing feature id attribute.
  • access: public
static Inx_Api_TriggerMailing_TriggerMailingAttribute INTERNAL_MAILING_FEATURE_ID ()
static method INTERNAL_MAILING_LIST_ID (line 82)

Constant for the mailing list id attribute.

Constant for the mailing list id attribute. This constant is used internally only.

  • return: the mailing list id attribute.
  • access: public
static Inx_Api_TriggerMailing_TriggerMailingAttribute INTERNAL_MAILING_LIST_ID ()
static method MODIFICATION_DATETIME (line 270)

Constant for the modification datetime attribute.

Constant for the modification datetime attribute. Used for ordering by the TriggerMailingManager.

  • return: the modification datetime attribute.
  • see: Inx_Api_TriggerMailing_TriggerMailingManager::selectByState( Inx_Api_List_ListContext $listContext, Inx_Api_TriggerMailing_StateFilter $stateFilter, Inx_Api_TriggerMailing_TriggerMailingAttribute $orderAttribute = null, $iOrderType = null, $sFilter = null )
  • access: public
static Inx_Api_TriggerMailing_TriggerMailingAttribute MODIFICATION_DATETIME ()
static method NAME (line 332)

Constant for the name attribute.

Constant for the name attribute. Used for ordering by the TriggerMailingManager

  • return: the name attribute.
  • see: Inx_Api_TriggerMailing_TriggerMailingManager::selectByState( Inx_Api_List_ListContext $listContext, Inx_Api_TriggerMailing_StateFilter $stateFilter, Inx_Api_TriggerMailing_TriggerMailingAttribute $orderAttribute = null, $iOrderType = null, $sFilter = null )
  • access: public
static method PLAIN_TEXT (line 137)

Constant for the plain text attribute.

Constant for the plain text attribute.

  • return: the plain text attribute.
  • access: public
static method PLAIN_TEXT_XSL (line 176)

Constant for the plain text style XML content attribute.

Constant for the plain text style XML content attribute.

  • return: the plain text style XML content attribute.
  • access: public
static method PRIORITY (line 254)

Constant for the priority attribute.

Constant for the priority attribute.

  • return: the priority attribute.
  • access: public
static method RECIPIENT_ADDRESS (line 228)

Constant for the recipient address attribute.

Constant for the recipient address attribute.

  • return: the recipient address attribute.
  • access: public
static method REPLY_TO_ADDRESS (line 241)

Constant for the reply address attribute.

Constant for the reply address attribute.

  • return: the reply address attribute.
  • access: public
static method SENDER_ADDRESS (line 215)

Constant for the sender address attribute.

Constant for the sender address attribute.

  • return: the sender address attribute.
  • access: public
static method SINGLE_SEND_COUNT (line 316)

Constant for the single send count attribute.

Constant for the single send count attribute. Used for ordering by the TriggerMailingManager

  • return: the single send count attribute.
  • see: Inx_Api_TriggerMailing_TriggerMailingManager::selectByState( Inx_Api_List_ListContext $listContext, Inx_Api_TriggerMailing_StateFilter $stateFilter, Inx_Api_TriggerMailing_TriggerMailingAttribute $orderAttribute = null, $iOrderType = null, $sFilter = null )
  • access: public
static method STYLE (line 284)

Constant for the style attribute.

Constant for the style attribute. Used by the UpdateException to identify the error source.

static method SUBJECT (line 124)

Constant for the subject attribute.

Constant for the subject attribute. Used for ordering by the TriggerMailingManager.

  • return: the subject attribute.
  • see: Inx_Api_TriggerMailing_TriggerMailingManager::selectByState( Inx_Api_List_ListContext $listContext, Inx_Api_TriggerMailing_StateFilter $stateFilter, Inx_Api_TriggerMailing_TriggerMailingAttribute $orderAttribute = null, $iOrderType = null, $sFilter = null )
  • access: public
static method UNKNOWN (line 375)

Constant for an unknown attribute. be used by the UpdateException to identify the error source.

Constant for an unknown attribute. This attribute indicates a version mismatch between API and server. It might be used by the UpdateException to identify the error source.

static method values (line 467)

Returns an array containing all available TriggerMailingAttributes including UNKNOWN.

Returns an array containing all available TriggerMailingAttributes including UNKNOWN.

  • return: an array containing all available TriggerMailingAttributes including UNKNOWN.
  • access: public
static array values ()
static method XML_CONTENT (line 163)

Constant for the XML content attribute.

Constant for the XML content attribute.

  • return: the XML content attribute.
  • access: public
getId (line 401)

Returns the ID of the TriggerMailingAttribute. not be used inside client code.

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

  • return: the ID of the TriggerMailingAttribute.
  • access: public
int getId ()
isOrderAttribute (line 413)

Returns a bool indicating if this TriggerMailingAttribute can be used for ordering of result sets.

Returns a bool indicating if this TriggerMailingAttribute can be used for ordering of result sets.

  • return: true if this attribute can be used for ordering, false otherwise.
  • access: public
bool isOrderAttribute ()

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