com.exacttarget.fuelsdk

Class ETSubscriber

java.lang.Object

com.exacttarget.fuelsdk.ETObject

com.exacttarget.fuelsdk.ETApiObject

com.exacttarget.fuelsdk.ETSoapObject

com.exacttarget.fuelsdk.ETSubscriber

public class ETSubscriber
extends ETSoapObject

An ETSubscriber object represents an email subscriber in the Salesforce Marketing Cloud.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ETSubscriber.Status Subscriber Status that can be used

Nested classes/interfaces inherited from class com.exacttarget.fuelsdk.ETSoapObject

ETSoapObject.DataExtensionRowConverter, ETSoapObject.EnumConverter, ETSoapObject.ExternalObjectConverter, ETSoapObject.InternalObjectConverter

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ETProfileAttribute>	attributes
protected List<ETSubscriberList>	lists

Fields inherited from class com.exacttarget.fuelsdk.ETSoapObject

PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
ETSubscriber() Class constructor, Initializes a new instance of the class.

Method Summary

Modifier and Type	Method and Description
List<ETProfileAttribute>	getAttributes()
Date	getCreatedDate()
String	getEmailAddress()
String	getId()
String	getKey()
List<ETSubscriberList>	getLists()
Date	getModifiedDate()
ETEmail.Type	getPreferredEmailType()
ETSubscriber.Status	getStatus()
String	getSubscriberKey() Deprecated. Use getKey().
Date	getUnsubscribedDate()
void	setAttributes(List<ETProfileAttribute> attribs)
void	setCreatedDate(Date createdDate)
void	setEmailAddress(String emailAddress)
void	setId(String id)
void	setKey(String key)
void	setModifiedDate(Date modifiedDate)
void	setPreferredEmailType(ETEmail.Type preferredEmailType)
void	setStatus(ETSubscriber.Status status)
void	setSubscriberKey(String subscriberKey) Deprecated. Use setKey().
void	setUnsubscribedDate(Date unsubscribedDate)

Methods inherited from class com.exacttarget.fuelsdk.ETSoapObject

create, delete, delete, fromInternal, getInternalProperties, getInternalProperty, retrieve, retrieve, retrieve, retrieve, toFilterPart, toInternal, update

Methods inherited from class com.exacttarget.fuelsdk.ETApiObject

getAllModified, getModified, setModified

Methods inherited from class com.exacttarget.fuelsdk.ETObject

getAllFields, getAllFields, getClient, getField, getField, setClient, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

lists

protected List<ETSubscriberList> lists

attributes

protected List<ETProfileAttribute> attributes

Constructor Detail

ETSubscriber

public ETSubscriber()

Class constructor, Initializes a new instance of the class.

Method Detail

getId

public String getId()

Specified by:

getId in class ETApiObject

Returns:

The Identifier of the ETSubscriber object.

setId

public void setId(String id)

Specified by:

setId in class ETApiObject

Parameters:

id - The Identifier of the ETSubscriber object.

getKey

public String getKey()

Returns:

The Customer Key of the ETSubscriber object.

setKey

public void setKey(String key)

Parameters:

key - The Customer Key of the ETSubscriber object.

getCreatedDate

public Date getCreatedDate()

Returns:

The created date of the ETSubscriber object.

setCreatedDate

public void setCreatedDate(Date createdDate)

Parameters:

createdDate - The created date of the ETSubscriber object.

getModifiedDate

public Date getModifiedDate()

Returns:

The modified date of the ETSubscriber object.

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Parameters:

modifiedDate - The modified date of the ETSubscriber object.

getEmailAddress

public String getEmailAddress()

Returns:

The email address of the ETSubscriber object.

setEmailAddress

public void setEmailAddress(String emailAddress)

Parameters:

emailAddress - The email address of the ETSubscriber object.

getPreferredEmailType

public ETEmail.Type getPreferredEmailType()

Returns:

The preferred email type of the ETSubscriber object. ETEmail.Type

setPreferredEmailType

public void setPreferredEmailType(ETEmail.Type preferredEmailType)

Parameters:

preferredEmailType - The preferred email type of the ETSubscriber object. ETEmail.Type

getStatus

public ETSubscriber.Status getStatus()

Returns:

The Status of the ETSubscriber object. ETSubscriber.Status

setStatus

public void setStatus(ETSubscriber.Status status)

Parameters:

status - The status of the ETSubscriber object. ETSubscriber.Status

getUnsubscribedDate

public Date getUnsubscribedDate()

Returns:

The unsubscribed date of the ETSubscriber object.

setUnsubscribedDate

public void setUnsubscribedDate(Date unsubscribedDate)

Parameters:

unsubscribedDate - The unsubscribed date of the ETSubscriber object.

getLists

public List<ETSubscriberList> getLists()

Returns:

The List of ETSubscriberList of this ETSubscriber object.

getAttributes

public List<ETProfileAttribute> getAttributes()

Returns:

Gets the List of the attributes property.

setAttributes

public void setAttributes(List<ETProfileAttribute> attribs)

getSubscriberKey

@Deprecated
public String getSubscriberKey()

Deprecated. Use getKey().

setSubscriberKey

@Deprecated
public void setSubscriberKey(String subscriberKey)

Deprecated. Use setKey().