Class Inx_Api_TriggerMailing_TriggerState

Description

The Inx_Api_TriggerMailing_TriggerState enumeration defines the states in which a trigger may transit. time trigger mailings, the trigger state is either ACTIVE or INACTIVE, which is the initial state.

The Inx_Api_TriggerMailing_TriggerState enumeration defines the states in which a trigger may transit. For time trigger mailings, the trigger state is either ACTIVE or INACTIVE, which is the initial state. For action mailings it is UNSPECIFIED.

Located in /Api/TriggerMailing/TriggerState.php (line 16)


	
			
Method Summary
Methods
static method ACTIVE (line 32)

State constant for the active state. mailing may be sent during the next dispatch interval.

State constant for the active state. This state indicates that the trigger has been activated and the trigger mailing may be sent during the next dispatch interval.

  • return: the active state.
  • access: public
static method byId (line 113)

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

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

  • return: the TriggerState corresponding to the given ID.
  • access: public
static Inx_Api_TriggerMailing_TriggerState byId (int $iState)
  • int $iState: the ID of the TriggerState to retrieve.
static method INACTIVE (line 47)

State constant for the inactive state. trigger has not yet been activated or was deactivated. dispatch interval.

State constant for the inactive state. This is the initial state of time trigger mailings and indicates that the trigger has not yet been activated or was deactivated. The trigger mailing will not be sent during the next dispatch interval.

  • return: the inactive state.
  • access: public
static method UNKNOWN (line 60)

State constant for an unknown state.

State constant for an unknown state. This state indicates a version mismatch between API and server.

  • return: the unknown state.
  • access: public
static method UNSPECIFIED (line 77)

State constant for the unspecified state. that the trigger (in this case an action) cannot be activated or deactivated. Inx_Api_TriggerMailing_TriggerMailing::activateSending() and Inx_Api_TriggerMailing_TriggerMailing::deactivateSending(bool) methods. all action mailings when used inside a Inx_Api_TriggerMailing_StateFilter.

State constant for the unspecified state. This is the initial (and only) state of action mailings and indicates that the trigger (in this case an action) cannot be activated or deactivated. using the Inx_Api_TriggerMailing_TriggerMailing::activateSending() and Inx_Api_TriggerMailing_TriggerMailing::deactivateSending(bool) methods. This state can be used to retrieve all action mailings when used inside a Inx_Api_TriggerMailing_StateFilter.

  • return: the unspecified state.
  • access: public
static Inx_Api_TriggerMailing_TriggerState UNSPECIFIED ()
static method values (line 131)

Returns an array containing all available TriggerStates including UNKNOWN.

Returns an array containing all available TriggerStates including UNKNOWN.

  • return: an array containing all available TriggerStates including UNKNOWN.
  • access: public
static array values ()
getId (line 100)

Returns the ID of the TriggerState. inside client code.

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

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

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