Class Inx_Api_Sending_SendingState

Description

The Inx_Api_Sending_SendingState enumeration defines the states in which a sending may transit.

The Inx_Api_Sending_SendingState enumeration defines the states in which a sending may transit.

Located in /Api/Sending/SendingState.php (line 15)


	
			
Method Summary
Methods
static method byId (line 142)

Returns the SendingState corresponding to the given id. UNKNOWN state will be returned. inside client code.

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

  • return: the SendingState corresponding to the given ID.
  • access: public
static Inx_Api_Sending_SendingState byId (int $iId)
  • int $iId: the ID of the SendingState to retrieve.
static method CRASHED (line 70)

The CRASHED state indicates that the sending process crashed and could not be finished.

The CRASHED state indicates that the sending process crashed and could not be finished.

  • return: the CRASHED state.
  • access: public
static Inx_Api_Sending_SendingState CRASHED ()
static method FINISHED (line 83)

The FINISHED state indicates that the sending was successfully completed.

The FINISHED state indicates that the sending was successfully completed.

  • return: the FINISHED state.
  • access: public
static Inx_Api_Sending_SendingState FINISHED ()
static method NOT_STARTED (line 31)

The NOT_STARTED state is the initial state of a sending, stating that the sending has not yet been started or prepared.

The NOT_STARTED state is the initial state of a sending, stating that the sending has not yet been started or prepared.

  • return: the NOT_STARTED state.
  • access: public
static Inx_Api_Sending_SendingState NOT_STARTED ()
static method PREPARED (line 96)

The PREPARED state indicates that the mailing has been prepared for all recipients and is ready to be sent.

The PREPARED state indicates that the mailing has been prepared for all recipients and is ready to be sent.

  • return: the PREPARED state.
  • access: public
static Inx_Api_Sending_SendingState PREPARED ()
static method SENDING (line 44)

The SENDING state indicates that the sending is in process.

The SENDING state indicates that the sending is in process.

  • return: the SENDING state.
  • access: public
static Inx_Api_Sending_SendingState SENDING ()
static method UNKNOWN (line 109)

The UNKNOWN state indicates a version mismatch between API and server.

The UNKNOWN state indicates a version mismatch between API and server.

  • return: the UNKNOWN state.
  • access: public
static Inx_Api_Sending_SendingState UNKNOWN ()
static method USER_INTERRUPTED (line 57)

The USER_INTERRUPTED state indicates that the sending process was interrupted by a user.

The USER_INTERRUPTED state indicates that the sending process was interrupted by a user.

  • return: the USER_INTERRUPTED state.
  • access: public
static Inx_Api_Sending_SendingState USER_INTERRUPTED ()
static method values (line 158)

Returns all valid SendingStates.

Returns all valid SendingStates.

  • return: All valid SendingStates.
  • access: public
static array values ()
getId (line 129)

Returns the ID of the SendingState. inside client code.

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

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

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