Interface Inx_Api_Recipient_RecipientMetaData

Description

An Inx_Api_Recipient_RecipientMetaData object contains meta data about the recipients represented by an Inx_Api_Recipient_RecipientContext object.

An Inx_Api_Recipient_RecipientMetaData object contains meta data about the recipients represented by an Inx_Api_Recipient_RecipientContext object. The meta data includes information about the available attributes, though can not be used to retrieve the actual attribute values.

Located in /Api/Recipient/RecipientMetaData.php (line 19)


	
			
Method Summary
Methods
getAttribute (line 90)

Returns the attribute specified by the given id.

Returns the attribute specified by the given id.

  • return: the attribute object.
  • throws: Inx_Api_Recipient_AttributeNotFoundException if the attribute could not be found.
  • access: public
Inx_Api_Recipient_Attribute getAttribute (int $iAttributeId)
  • int $iAttributeId: the id of the attribute to retrieve.
getAttributeCount (line 97)

Returns the number of attributes.

Returns the number of attributes.

  • return: the number of attributes.
  • access: public
int getAttributeCount ()
getAttributeIterator (line 118)

Returns an Inx_Apiimpl_Recipient_RecipientContextImpl_AttributeIterator over the attributes in this meta data.

Returns an Inx_Apiimpl_Recipient_RecipientContextImpl_AttributeIterator over the attributes in this meta data. The following snippet shows how to iterate over the recipient attributes:

 $oRecipientMetaData = $oSession->createRecipientContext()->getMetaData();
 $oAttributeIterator = $oRecipientMetaData->getAttributeIterator();

 while( $oAttributeIterator->hasNext() )
 {
  $oAttribute = $oAttributeIterator->current();
 	echo $oAttribute->getName()."<br>";
  $oAttributeIterator->next();
 }

  • return: an iterator over the attributes.
  • access: public
getEmailAttribute (line 41)

Returns the email attribute.

Returns the email attribute.

  • return: the email attribute.
  • access: public
Inx_Api_Recipient_Attribute getEmailAttribute ()
getHardbounceAttribute (line 58)

Returns the hardbounce attribute.

Returns the hardbounce attribute.

  • return: the hardbounce attribute.
  • access: public
Inx_Api_Recipient_Attribute getHardbounceAttribute ()
getIdAttribute (line 27)

Returns the id attribute.

Returns the id attribute.

  • return: the id attribute.
  • access: public
Inx_Api_Recipient_Attribute getIdAttribute ()
getKeyAttribute (line 34)

Returns the key attribute.

Returns the key attribute.

  • return: the key attribute.
  • access: public
Inx_Api_Recipient_Attribute getKeyAttribute ()
getLastModificationAttribute (line 49)

Returns the last modification attribute.

Returns the last modification attribute.

  • return: the last modification attribute.
  • access: public
Inx_Api_Recipient_Attribute getLastModificationAttribute ()
getSubscriptionAttribute (line 80)

Returns the subscription attribute for the specified list.

Returns the subscription attribute for the specified list. A recipient has a subscription attribute for each standard list.

  • return: the attribute object.
  • throws: Inx_Api_Recipient_AttributeNotFoundException if the list is not a standard list.
  • access: public
Inx_Api_Recipient_Attribute getSubscriptionAttribute (Inx_Api_List_ListContext $oList)
getUserAttribute (line 69)

Returns the attribute specified by the given name.

Returns the attribute specified by the given name.

  • return: the attribute object.
  • throws: Inx_Api_Recipient_AttributeNotFoundException if the attribute could not be found.
  • access: public
Inx_Api_Recipient_Attribute getUserAttribute (string $sAttributeName)
  • string $sAttributeName: the name of the attribute to retrieve, ignoring case considerations.

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