Interface Inx_Api_Action_CommandFactory

Description

The Inx_Api_Action_CommandFactory is a factory for creating Inx_Api_Action_Commands.

The Inx_Api_Action_CommandFactory is a factory for creating Inx_Api_Action_Commands. For an example on how to use commands and actions, see the Inx_Api_Action_ActionManager documentation.

Located in /Api/Action/CommandFactory.php (line 19)


	
			
Method Summary
Inx_Api_Action_SendActionMailCommand createSendActionMailCmd (int $iListContextId, int $iActionMailingId)
Inx_Api_Action_SendMailCommand createSendMailCmd (int $iListContextId, int $iMailingId)
Inx_Api_Action_SetValue_Command createSetAbsoluteValueCmd (int $iAttributeId, string $sAbsoluteValue)
Inx_Api_Action_SetValueCommand createSetRelativeValueCmd (int $iAttributeId, string $sRelativeValue)
Inx_Api_Action_SetValueCommand createSetValueCmd (int $iAttributeId, string $sExpression)
Inx_Api_Action_SubUnsubscriptionCommand createSubscriptionCmd (int $iListContextId, bool $blSubscriptionProcessingEnabled)
Inx_Api_Action_SubscriptionCommand createSubscriptionCmd2 (int $iListContextId, bool $blSubscriptionProcessingEnabled)
Inx_Api_Action_SubUnsubscriptionCommand createUnsubscriptionCmd (int $iListContextId, bool $blSnsubscriptionProcessingEnabled)
Inx_Api_Action_UnsubscriptionCommand createUnsubscriptionCmd2 (int $iListContextId, bool $blSnsubscriptionProcessingEnabled)
Methods
createDeleteRecipientCmd (line 28)

Creates a new Inx_Api_Action_DeleteRecipientCommand that will delete the recipient permanently from the system.

Creates a new Inx_Api_Action_DeleteRecipientCommand that will delete the recipient permanently from the system.

  • return: a new Inx_Api_Action_DeleteRecipientCommand.
  • access: public
Inx_Api_Action_DeleteRecipientCommand createDeleteRecipientCmd ()
createSendActionMailCmd (line 201)

Creates an Inx_Api_Action_SendActionMailCommand which sends the specified action mailing from the corresponding list context to the recipient.

Creates an Inx_Api_Action_SendActionMailCommand which sends the specified action mailing from the corresponding list context to the recipient.

  • return: a new Inx_Api_Action_SendActionMailCommand.
  • since: API 1.10.0
  • access: public
Inx_Api_Action_SendActionMailCommand createSendActionMailCmd (int $iListContextId, int $iActionMailingId)
  • int $iListContextId: id of the standard or filter list context containing the action mailing.
  • int $iActionMailingId: the id of the action mailing to send.
createSendLastNewsletterCmd (line 179)

Creates an Inx_Api_Action_SendMailCommand which sends the last newsletter from the specified list context to the recipient.

Creates an Inx_Api_Action_SendMailCommand which sends the last newsletter from the specified list context to the recipient.

  • return: a new Inx_Api_Action_SendMailCommand.
  • access: public
Inx_Api_Action_SendMailCommand createSendLastNewsletterCmd (int $iListContextId)
  • int $iListContextId: the id of the standard or filter list context.
createSendMailCmd (line 190)

Creates an Inx_Api_Action_SendMailCommand which sends the specified mailing from the corresponding list context to the recipient.

Creates an Inx_Api_Action_SendMailCommand which sends the specified mailing from the corresponding list context to the recipient.

  • return: a new Inx_Api_Action_SendMailCommand.
  • access: public
Inx_Api_Action_SendMailCommand createSendMailCmd (int $iListContextId, int $iMailingId)
  • int $iListContextId: the id of the standard or filter list context containing the mailing.
  • int $iMailingId: the id of the mailing to send.
createSetAbsoluteValueCmd (line 68)

Creates an Inx_Api_Action_SetValueCommand which sets an absolute value.

Creates an Inx_Api_Action_SetValueCommand which sets an absolute value. Some examples for allowed values, dependent on the data type:

  • DataType.TEXT - "Text", null
  • DataType.INTEGER - "12", "-3", null
  • DataType.DOUBLE - "3.4", "-1.25", null
  • DataType.BOOLEAN - "TRUE", "FALSE"
  • DataType.DATETIME - "31.12.2006 23:45:00"; (dd.MM.yyyy HH:mm:ss or dd.MM.yyyy HH:mm), null
  • DataType.DATE - "31.12.2006"; (dd.MM.yyyy), null
  • DataType.TIME - "23:45:00"; (HH:mm:ss or HH:mm), null

Inx_Api_Action_SetValue_Command createSetAbsoluteValueCmd (int $iAttributeId, string $sAbsoluteValue)
  • int $iAttributeId: the id of the user attribute.
  • string $sAbsoluteValue: an absolute value for the attribute.
createSetRelativeValueCmd (line 90)

Creates an Inx_Api_Action_SetValueCommand which sets a relative value.

Creates an Inx_Api_Action_SetValueCommand which sets a relative value. Examples for allowed values, dependent on the data type:

  • DataType.TEXT - "3", "-10"
  • DataType.INTEGER - "12", "-3"
  • DataType.DOUBLE - "3.4", "-1.25"
You might wonder why text attributes can be incremented/decremented. This is a convenience for attributes that are numbers by nature but have the type text. DO NOT use this method for changing real text attributes, as this will overwrite the value.

Inx_Api_Action_SetValueCommand createSetRelativeValueCmd (int $iAttributeId, string $sRelativeValue)
  • int $iAttributeId: the id of the user attribute.
  • string $sRelativeValue: a relative value for the attribute that can be positive (increment) or negative (decrement).
createSetValueCmd (line 47)

Creates an Inx_Api_Action_SetValueCommand which sets a value based on an expression.

Creates an Inx_Api_Action_SetValueCommand which sets a value based on an expression. The expression must begin with an equal sign. The data type of the expression must be the same as the data type of the specified attribute. See the Inxmail client documentation for a detailed description.

 $oFactory->createSetValueCmd( $oDatetimeAttr->getId(), "=Date()" );

Inx_Api_Action_SetValueCommand createSetValueCmd (int $iAttributeId, string $sExpression)
  • int $iAttributeId: the id of the user attribute.
  • string $sExpression: an expression that sets the value of the attribute.
createSubscriptionCmd (line 104)

Creates an Inx_Api_Action_SubUnsubscriptionCommand which subscribes the recipient to the specified standard list.

Creates an Inx_Api_Action_SubUnsubscriptionCommand which subscribes the recipient to the specified standard list.

  • return: a new Inx_Api_Action_SubUnsubscriptionCommand.
  • deprecated: use createSubscriptionCmd2(int, bool) instead.
  • access: public
Inx_Api_Action_SubUnsubscriptionCommand createSubscriptionCmd (int $iListContextId, bool $blSubscriptionProcessingEnabled)
  • int $iListContextId: the id of the standard list context to which to subscribe to.
  • bool $blSubscriptionProcessingEnabled: true if subscription processing is enabled, false if direct (forced) subscription is used. If processing and double opt in (DOI) are enabled, this will send a verification email to the recipient.
createSubscriptionCmd2 (line 142)

Creates an Inx_Api_Action_SubscriptionCommand which subscribes the recipient to the specified standard list.

Creates an Inx_Api_Action_SubscriptionCommand which subscribes the recipient to the specified standard list.

  • return: a new Inx_Api_Action_SubscriptionCommand.
  • since: API 1.6.0
  • access: public
Inx_Api_Action_SubscriptionCommand createSubscriptionCmd2 (int $iListContextId, bool $blSubscriptionProcessingEnabled)
  • int $iListContextId: the id of the standard list context to which to subscribe to.
  • bool $blSubscriptionProcessingEnabled: true if subscription processing is enabled, false if direct (forced) subscription is used. If processing and double opt in (DOI) are enabled, this will send a verification email to the recipient.
createUnsubscribeAllCmd (line 128)

Creates an Inx_Api_Action_SubUnsubscriptionCommand which unsubscribes the recipient from all standard lists.

Creates an Inx_Api_Action_SubUnsubscriptionCommand which unsubscribes the recipient from all standard lists.

  • return: a new Inx_Api_Action_SubUnsubscriptionCommand.
  • deprecated: use createUnsubscribeAllCmd2() instead.
  • access: public
Inx_Api_Action_SubUnsubscriptionCommand createUnsubscribeAllCmd ()
createUnsubscribeAllCmd2 (line 168)

Creates an Inx_Api_Action_UnsubscriptionCommand which unsubscribes the recipient from all standard lists.

Creates an Inx_Api_Action_UnsubscriptionCommand which unsubscribes the recipient from all standard lists.

  • return: a new Inx_Api_Action_UnsubscriptionCommand.
  • since: API 1.6.0
  • access: public
Inx_Api_Action_UnsubscriptionCommand createUnsubscribeAllCmd2 ()
createUnsubscriptionCmd (line 118)

Creates an Inx_Api_Action_SubUnsubscriptionCommand which unsubscribes the recipient from the specified standard list.

Creates an Inx_Api_Action_SubUnsubscriptionCommand which unsubscribes the recipient from the specified standard list.

  • return: a new Inx_Api_Action_SubUnsubscriptionCommand.
  • deprecated: use createUnsubscriptionCmd2(int, bool) instead.
  • access: public
Inx_Api_Action_SubUnsubscriptionCommand createUnsubscriptionCmd (int $iListContextId, bool $blSnsubscriptionProcessingEnabled)
  • int $iListContextId: the id of the standard list context from which to unsubscribe from.
  • bool $blSnsubscriptionProcessingEnabled: true if unsubscription processing is enabled, false if direct (forced) unsubscription is used. If processing and double opt out (DOO) are enabled, this will send a verification email to the recipient.
createUnsubscriptionCmd2 (line 157)

Creates an Inx_Api_Action_UnsubscriptionCommand which unsubscribes the recipient from the specified standard list.

Creates an Inx_Api_Action_UnsubscriptionCommand which unsubscribes the recipient from the specified standard list.

  • return: a new Inx_Api_Action_UnsubscriptionCommand.
  • since: API 1.6.0
  • access: public
Inx_Api_Action_UnsubscriptionCommand createUnsubscriptionCmd2 (int $iListContextId, bool $blSnsubscriptionProcessingEnabled)
  • int $iListContextId: the id of the standard list context from which to unsubscribe from.
  • bool $blSnsubscriptionProcessingEnabled: true if unsubscription processing is enabled, false if direct (forced) unsubscription is used. If processing and double opt out (DOO) are enabled, this will send a verification email to the recipient.

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