The Inx_Api_Recipient_RecipientState enumeration defines the states of a recipient.
The Inx_Api_Recipient_RecipientState enumeration defines the states of a recipient. These states are used in query results to indicate whether the associated recipient is known and still available. There are three possible values:
Located in /Api/Recipient/RecipientState.php (line 20)
Returns the Inx_Api_Recipient_RecipientState corresponding to the given id.
Returns the Inx_Api_Recipient_RecipientState 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.
Used if the recipient is known but was deleted.
Used if the recipient is known but was deleted.
Used if the recipient is known and active.
Used if the recipient is known and active.
Used if the recipient (or its state) is unknown.
Used if the recipient (or its state) is unknown. This can have various reasons:
Returns an array containing all available RecipientStates including UNKNOWN.
Returns an array containing all available RecipientStates including UNKNOWN.
Returns the ID of this Inx_Api_Recipient_RecipientState.
Returns the ID of this Inx_Api_Recipient_RecipientState. The ID is used for transmission purposes and should not be used inside client code.
Documentation generated on Thu, 17 Sep 2015 14:27:28 +0200 by phpDocumentor 1.3.2