com.urbanairship.api.channel.model.email.RegisterEmailChannel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
Show all versions of java-client Show documentation
The Urban Airship Java client library
package com.urbanairship.api.channel.model.email;
import com.google.common.base.Objects;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.urbanairship.api.channel.model.ChannelType;
import com.urbanairship.api.push.model.PushModelObject;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Represents the payload to be used for registering or updating an email channel.
*/
public class RegisterEmailChannel extends PushModelObject {
private final ChannelType type;
private final Optional> emailOptInLevel;
private final String address;
private final Optional setTags;
private final Optional> tags;
private final Optional timezone;
private final Optional localeCountry;
private final Optional localeLanguage;
//Protected to facilitate subclassing for create and send child object
protected RegisterEmailChannel(Builder builder) {
this.type = ChannelType.EMAIL;
this.emailOptInLevel = Optional.fromNullable((builder.emailOptInLevel));
this.address = builder.address;
this.setTags = Optional.fromNullable(builder.set_tags);
this.timezone = Optional.fromNullable(builder.timezone);
this.localeCountry = Optional.fromNullable(builder.localeCountry);
this.localeLanguage = Optional.fromNullable(builder.localeLanguage);
if (builder.tags.build().isEmpty()) {
this.tags = Optional.absent();
} else {
this.tags = Optional.of(builder.tags.build());
}
}
/**
* Get the RegisterEmailChannelType.
*
* @return ChannelType type
*/
public ChannelType getType() {
return ChannelType.EMAIL;
}
/**
* Get the channel email opt in level.
*
* @return Optional OptInLevel emailOptInLevel
*/
public Optional> getEmailOptInLevel() {
return emailOptInLevel;
}
/**
* Get the email channel's address,
*
* @return String address
*/
public String getAddress() {
return address;
}
/**
* Get a String representation of the timezone.
*
* @return Optional String timezone
*/
public Optional getTimezone() {
return timezone;
}
/**
* Get a String representation of the locale country.
*
* @return Optional String localeCountry
*/
public Optional getLocaleCountry() {
return localeCountry;
}
/**
* Get a String representation of the locale language.
*
* @return Optional String localeLanguage
*/
public Optional getLocaleLanguage() {
return localeLanguage;
}
/**
* New RegisterEmailChannel builder.
*
* @return Builder
*/
public static Builder newBuilder() {
return new Builder();
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
RegisterEmailChannel that = (RegisterEmailChannel) o;
return type == that.type &&
Objects.equal(address, that.address) &&
Objects.equal(setTags, that.setTags) &&
Objects.equal(tags, that.tags) &&
Objects.equal(timezone, that.timezone) &&
Objects.equal(localeCountry, that.localeCountry) &&
Objects.equal(localeLanguage, that.localeLanguage) &&
Objects.equal(emailOptInLevel, that.emailOptInLevel);
}
@Override
public String toString() {
return "RegisterEmailChannel{" +
"type=" + type +
", emailOptInLevel=" + emailOptInLevel +
", address=" + address +
", setTags=" + setTags +
", tags=" + tags +
", timezone=" + timezone +
", localeCountry=" + localeCountry +
", localeLanguage=" + localeLanguage +
'}';
}
@Override
public int hashCode() {
return Objects.hashCode(type, emailOptInLevel, address, setTags, tags, timezone, localeCountry, localeLanguage);
}
/**
* Create RegisterEmailChannel Builder
*/
public final static class Builder {
private ChannelType type;
private String address;
private String timezone;
private ImmutableList.Builder tags = ImmutableList.builder();
private boolean set_tags;
private String localeCountry;
private String localeLanguage;
private Map emailOptInLevel = new HashMap<>();
protected Builder() {
}
/**
* Set the EmailOptInLevel status and time.
*
* @param level time OptInLevel, String
* @param time String
* @return RegisterEmailChannel Builder
*/
public Builder setEmailOptInLevel(OptInLevel level, String time) {
this.emailOptInLevel.put(level, time);
return this;
}
/**
* Set the channel's address, a Unique identifier of the object
* used as the primary ID in the delivery tier (Email).
*
* @param address String
* @return RegisterEmailChannel Builder
*/
public Builder setAddress(String address) {
this.address = address;
return this;
}
/**
* Optional, though required if tags is present.
* If true on update, value of tags overwrites any existing tags.
* If false, tags are unioned with existing tags.
*
* @param setTags boolean
* @return Channel Builder
*/
public Builder setTags(boolean setTags) {
this.set_tags = setTags;
return this;
}
/**
* Add a List of String representations of tags.
*
* @param tags A List of Strings
* @return Channel Builder
*/
public Builder addAllTags(List tags) {
this.tags.addAll(tags);
return this;
}
/**
* Set a String representation of a tag.
*
* @param tag String
* @return Channel Builder
*/
public Builder addTag(String tag) {
tags.add(tag);
return this;
}
/**
* Set timezone string. An IANA tzdata identifier for the timezone
* as a string, e.g., "America/Los Angeles". Will set the timezone
* tag group tag with the specified value.
*
* @param timezone String
* @return RegisterEmailChannel Builder
*/
public Builder setTimeZone(String timezone) {
this.timezone = timezone;
return this;
}
/**
* Set a the localeCountry The two-letter country locale shortcode.
* Will set the ua_locale_country tag group to the specified value.
* Used _ notation to conform with previously written code
*
* @param locale_country String
* @return RegisterEmailChannel Builder
*/
public Builder setLocaleCountry(String locale_country) {
this.localeCountry = locale_country;
return this;
}
/**
* Set a String localeLanguage, the two-letter language locale
* shortcode. Will set the ua_locale_language tag group to the
* specified value
* Used _ notation to conform with previously written code
*
* @param locale_language String
* @return RegisterEmailChannel Builder
*/
public Builder setLocaleLanguage(String locale_language) {
this.localeLanguage = locale_language;
return this;
}
public RegisterEmailChannel build() {
Preconditions.checkNotNull(address, "address cannot be null.");
Preconditions.checkNotNull(emailOptInLevel, "'emailOptInLevel' cannot be null.");
return new RegisterEmailChannel(this);
}
}
}