Subscriber (Salesforce Marketing Cloud Java SDK 1.2.1 API)

java.lang.Object
- com.exacttarget.fuelsdk.internal.APIObject
- - com.exacttarget.fuelsdk.internal.Subscriber

public class Subscriber
extends APIObject

Java class for Subscriber complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Subscriber">
   <complexContent>
     <extension base="{http://exacttarget.com/wsdl/partnerAPI}APIObject">
       <sequence>
         <element name="EmailAddress" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Attributes" type="{http://exacttarget.com/wsdl/partnerAPI}Attribute" maxOccurs="unbounded" minOccurs="0"/>
         <element name="SubscriberKey" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="UnsubscribedDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="Status" type="{http://exacttarget.com/wsdl/partnerAPI}SubscriberStatus" minOccurs="0"/>
         <element name="PartnerType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="EmailTypePreference" type="{http://exacttarget.com/wsdl/partnerAPI}EmailType" minOccurs="0"/>
         <element name="Lists" type="{http://exacttarget.com/wsdl/partnerAPI}SubscriberList" maxOccurs="unbounded" minOccurs="0"/>
         <element name="GlobalUnsubscribeCategory" type="{http://exacttarget.com/wsdl/partnerAPI}GlobalUnsubscribeCategory" minOccurs="0"/>
         <element name="SubscriberTypeDefinition" type="{http://exacttarget.com/wsdl/partnerAPI}SubscriberTypeDefinition" minOccurs="0"/>
         <element name="Addresses" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="Address" type="{http://exacttarget.com/wsdl/partnerAPI}SubscriberAddress" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="PrimarySMSAddress" type="{http://exacttarget.com/wsdl/partnerAPI}SMSAddress" minOccurs="0"/>
         <element name="PrimarySMSPublicationStatus" type="{http://exacttarget.com/wsdl/partnerAPI}SubscriberAddressStatus" minOccurs="0"/>
         <element name="PrimaryEmailAddress" type="{http://exacttarget.com/wsdl/partnerAPI}EmailAddress" minOccurs="0"/>
         <element name="Locale" type="{http://exacttarget.com/wsdl/partnerAPI}Locale" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Subscriber.Addresses
Java class for anonymous complex type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Subscriber.Addresses` Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Subscriber.Addresses`	`addresses`
`protected List<Attribute>`	`attributes`
`protected String`	`emailAddress`
`protected EmailType`	`emailTypePreference`
`protected GlobalUnsubscribeCategory`	`globalUnsubscribeCategory`
`protected List<SubscriberList>`	`lists`
`protected Locale`	`locale`
`protected String`	`partnerType`
`protected EmailAddress`	`primaryEmailAddress`
`protected SMSAddress`	`primarySMSAddress`
`protected SubscriberAddressStatus`	`primarySMSPublicationStatus`
`protected SubscriberStatus`	`status`
`protected String`	`subscriberKey`
`protected SubscriberTypeDefinition`	`subscriberTypeDefinition`
`protected Date`	`unsubscribedDate`

Fields inherited from class com.exacttarget.fuelsdk.internal.APIObject
client, correlationID, createdDate, customerKey, id, modifiedDate, objectID, objectState, owner, partnerKey, partnerProperties

Constructor Summary

Constructors
Constructor and Description

Subscriber()

Constructors
Constructor and Description
`Subscriber()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Subscriber.Addresses`	`getAddresses()` Gets the value of the addresses property.
`List<Attribute>`	`getAttributes()` Gets the value of the attributes property.
`String`	`getEmailAddress()` Gets the value of the emailAddress property.
`EmailType`	`getEmailTypePreference()` Gets the value of the emailTypePreference property.
`GlobalUnsubscribeCategory`	`getGlobalUnsubscribeCategory()` Gets the value of the globalUnsubscribeCategory property.
`List<SubscriberList>`	`getLists()` Gets the value of the lists property.
`Locale`	`getLocale()` Gets the value of the locale property.
`String`	`getPartnerType()` Gets the value of the partnerType property.
`EmailAddress`	`getPrimaryEmailAddress()` Gets the value of the primaryEmailAddress property.
`SMSAddress`	`getPrimarySMSAddress()` Gets the value of the primarySMSAddress property.
`SubscriberAddressStatus`	`getPrimarySMSPublicationStatus()` Gets the value of the primarySMSPublicationStatus property.
`SubscriberStatus`	`getStatus()` Gets the value of the status property.
`String`	`getSubscriberKey()` Gets the value of the subscriberKey property.
`SubscriberTypeDefinition`	`getSubscriberTypeDefinition()` Gets the value of the subscriberTypeDefinition property.
`Date`	`getUnsubscribedDate()` Gets the value of the unsubscribedDate property.
`void`	`setAddresses(Subscriber.Addresses value)` Sets the value of the addresses property.
`void`	`setEmailAddress(String value)` Sets the value of the emailAddress property.
`void`	`setEmailTypePreference(EmailType value)` Sets the value of the emailTypePreference property.
`void`	`setGlobalUnsubscribeCategory(GlobalUnsubscribeCategory value)` Sets the value of the globalUnsubscribeCategory property.
`void`	`setLocale(Locale value)` Sets the value of the locale property.
`void`	`setPartnerType(String value)` Sets the value of the partnerType property.
`void`	`setPrimaryEmailAddress(EmailAddress value)` Sets the value of the primaryEmailAddress property.
`void`	`setPrimarySMSAddress(SMSAddress value)` Sets the value of the primarySMSAddress property.
`void`	`setPrimarySMSPublicationStatus(SubscriberAddressStatus value)` Sets the value of the primarySMSPublicationStatus property.
`void`	`setStatus(SubscriberStatus value)` Sets the value of the status property.
`void`	`setSubscriberKey(String value)` Sets the value of the subscriberKey property.
`void`	`setSubscriberTypeDefinition(SubscriberTypeDefinition value)` Sets the value of the subscriberTypeDefinition property.
`void`	`setUnsubscribedDate(Date value)` Sets the value of the unsubscribedDate property.
`String`	`toString()` Generates a String representation of the contents of this type.

Methods inherited from class com.exacttarget.fuelsdk.internal.APIObject
getClient, getCorrelationID, getCreatedDate, getCustomerKey, getId, getModifiedDate, getObjectID, getObjectState, getOwner, getPartnerKey, getPartnerProperties, setClient, setCorrelationID, setCreatedDate, setCustomerKey, setId, setModifiedDate, setObjectID, setObjectState, setOwner, setPartnerKey

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - emailAddress
```
protected String emailAddress
```
  - attributes
```
protected List<Attribute> attributes
```
  - subscriberKey
```
protected String subscriberKey
```
  - unsubscribedDate
```
protected Date unsubscribedDate
```
  - status
```
protected SubscriberStatus status
```
  - partnerType
```
protected String partnerType
```
  - emailTypePreference
```
protected EmailType emailTypePreference
```
  - lists
```
protected List<SubscriberList> lists
```
  - globalUnsubscribeCategory
```
protected GlobalUnsubscribeCategory globalUnsubscribeCategory
```
  - subscriberTypeDefinition
```
protected SubscriberTypeDefinition subscriberTypeDefinition
```
  - addresses
```
protected Subscriber.Addresses addresses
```
  - primarySMSAddress
```
protected SMSAddress primarySMSAddress
```
  - primarySMSPublicationStatus
```
protected SubscriberAddressStatus primarySMSPublicationStatus
```
  - primaryEmailAddress
```
protected EmailAddress primaryEmailAddress
```
  - locale
```
protected Locale locale
```
- Constructor Detail
  - Subscriber
```
public Subscriber()
```
- Method Detail
  - getEmailAddress
```
public String getEmailAddress()
```
    Gets the value of the emailAddress property.
    
    Returns:
    
    possible object is String
  - setEmailAddress
```
public void setEmailAddress(String value)
```
    Sets the value of the emailAddress property.
    
    Parameters:
    
    value - allowed object is String
  - getAttributes
```
public List<Attribute> getAttributes()
```
    Gets the value of the attributes property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the attributes property.
    For example, to add a new item, do as follows:
```
    getAttributes().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Attribute
  - getSubscriberKey
```
public String getSubscriberKey()
```
    Gets the value of the subscriberKey property.
    
    Returns:
    
    possible object is String
  - setSubscriberKey
```
public void setSubscriberKey(String value)
```
    Sets the value of the subscriberKey property.
    
    Parameters:
    
    value - allowed object is String
  - getUnsubscribedDate
```
public Date getUnsubscribedDate()
```
    Gets the value of the unsubscribedDate property.
    
    Returns:
    
    possible object is String
  - setUnsubscribedDate
```
public void setUnsubscribedDate(Date value)
```
    Sets the value of the unsubscribedDate property.
    
    Parameters:
    
    value - allowed object is String
  - getStatus
```
public SubscriberStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is SubscriberStatus
  - setStatus
```
public void setStatus(SubscriberStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is SubscriberStatus
  - getPartnerType
```
public String getPartnerType()
```
    Gets the value of the partnerType property.
    
    Returns:
    
    possible object is String
  - setPartnerType
```
public void setPartnerType(String value)
```
    Sets the value of the partnerType property.
    
    Parameters:
    
    value - allowed object is String
  - getEmailTypePreference
```
public EmailType getEmailTypePreference()
```
    Gets the value of the emailTypePreference property.
    
    Returns:
    
    possible object is EmailType
  - setEmailTypePreference
```
public void setEmailTypePreference(EmailType value)
```
    Sets the value of the emailTypePreference property.
    
    Parameters:
    
    value - allowed object is EmailType
  - getLists
```
public List<SubscriberList> getLists()
```
    Gets the value of the lists property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the lists property.
    For example, to add a new item, do as follows:
```
    getLists().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SubscriberList
  - getGlobalUnsubscribeCategory
```
public GlobalUnsubscribeCategory getGlobalUnsubscribeCategory()
```
    Gets the value of the globalUnsubscribeCategory property.
    
    Returns:
    
    possible object is GlobalUnsubscribeCategory
  - setGlobalUnsubscribeCategory
```
public void setGlobalUnsubscribeCategory(GlobalUnsubscribeCategory value)
```
    Sets the value of the globalUnsubscribeCategory property.
    
    Parameters:
    
    value - allowed object is GlobalUnsubscribeCategory
  - getSubscriberTypeDefinition
```
public SubscriberTypeDefinition getSubscriberTypeDefinition()
```
    Gets the value of the subscriberTypeDefinition property.
    
    Returns:
    
    possible object is SubscriberTypeDefinition
  - setSubscriberTypeDefinition
```
public void setSubscriberTypeDefinition(SubscriberTypeDefinition value)
```
    Sets the value of the subscriberTypeDefinition property.
    
    Parameters:
    
    value - allowed object is SubscriberTypeDefinition
  - getAddresses
```
public Subscriber.Addresses getAddresses()
```
    Gets the value of the addresses property.
    
    Returns:
    
    possible object is Subscriber.Addresses
  - setAddresses
```
public void setAddresses(Subscriber.Addresses value)
```
    Sets the value of the addresses property.
    
    Parameters:
    
    value - allowed object is Subscriber.Addresses
  - getPrimarySMSAddress
```
public SMSAddress getPrimarySMSAddress()
```
    Gets the value of the primarySMSAddress property.
    
    Returns:
    
    possible object is SMSAddress
  - setPrimarySMSAddress
```
public void setPrimarySMSAddress(SMSAddress value)
```
    Sets the value of the primarySMSAddress property.
    
    Parameters:
    
    value - allowed object is SMSAddress
  - getPrimarySMSPublicationStatus
```
public SubscriberAddressStatus getPrimarySMSPublicationStatus()
```
    Gets the value of the primarySMSPublicationStatus property.
    
    Returns:
    
    possible object is SubscriberAddressStatus
  - setPrimarySMSPublicationStatus
```
public void setPrimarySMSPublicationStatus(SubscriberAddressStatus value)
```
    Sets the value of the primarySMSPublicationStatus property.
    
    Parameters:
    
    value - allowed object is SubscriberAddressStatus
  - getPrimaryEmailAddress
```
public EmailAddress getPrimaryEmailAddress()
```
    Gets the value of the primaryEmailAddress property.
    
    Returns:
    
    possible object is EmailAddress
  - setPrimaryEmailAddress
```
public void setPrimaryEmailAddress(EmailAddress value)
```
    Sets the value of the primaryEmailAddress property.
    
    Parameters:
    
    value - allowed object is EmailAddress
  - getLocale
```
public Locale getLocale()
```
    Gets the value of the locale property.
    
    Returns:
    
    possible object is Locale
  - setLocale
```
public void setLocale(Locale value)
```
    Sets the value of the locale property.
    
    Parameters:
    
    value - allowed object is Locale
  - toString
```
public String toString()
```
    Generates a String representation of the contents of this type. This is an extension method, produced by the 'ts' xjc plugin
    
    Overrides:
    
    toString in class APIObject

Class Subscriber

Nested Class Summary

Field Summary

Fields inherited from class com.exacttarget.fuelsdk.internal.APIObject

Constructor Summary

Method Summary

Methods inherited from class com.exacttarget.fuelsdk.internal.APIObject

Methods inherited from class java.lang.Object

Field Detail

emailAddress

attributes

subscriberKey

unsubscribedDate

status

partnerType

emailTypePreference

lists

globalUnsubscribeCategory

subscriberTypeDefinition

addresses

primarySMSAddress

primarySMSPublicationStatus

primaryEmailAddress

locale

Constructor Detail

Subscriber

Method Detail

getEmailAddress

setEmailAddress

getAttributes

getSubscriberKey

setSubscriberKey

getUnsubscribedDate

setUnsubscribedDate

getStatus

setStatus

getPartnerType

setPartnerType

getEmailTypePreference

setEmailTypePreference

getLists

getGlobalUnsubscribeCategory

setGlobalUnsubscribeCategory

getSubscriberTypeDefinition

setSubscriberTypeDefinition

getAddresses

setAddresses

getPrimarySMSAddress

setPrimarySMSAddress

getPrimarySMSPublicationStatus

setPrimarySMSPublicationStatus

getPrimaryEmailAddress

setPrimaryEmailAddress

getLocale

setLocale

toString