com.amazonaws.mobileconnectors.pinpoint.targeting.endpointProfile

Class EndpointProfile

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.targeting.endpointProfile.EndpointProfile

All Implemented Interfaces:

com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

public class EndpointProfile
extends java.lang.Object
implements com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

Represents the device endpoint for which your application may add information to The example below demonstrates how to add custom attributes

Constructor Summary

Constructors

Constructor and Description
EndpointProfile(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, java.util.List<java.lang.String> values) Adds a custom attribute to this EndpointProfile with the specified key.
void	addMetric(java.lang.String name, java.lang.Double value) Adds a metric to this EndpointProfile with the specified key.
java.lang.String	getAddress() Returns the Address of the endpoint.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAllAttributes() Returns a map of all custom attributes contained within this EndpointProfile
java.util.Map<java.lang.String,java.lang.Double>	getAllMetrics() Returns a map of all metrics contained within this EndpointProfile
java.lang.String	getApplicationId() Returns the Mobile Analytics application Id
java.util.List<java.lang.String>	getAttribute(java.lang.String name) Returns the array of values of the custom attribute with the specified name.
java.lang.String	getChannelType() Returns the Channel Type of this endpoint, currently defaults to GCM
EndpointProfileDemographic	getDemographic() Returns the Demographic facet of the endpoint.
long	getEffectiveDate() Returns the effective date of the endpoint.
java.lang.String	getEndpointId() Returns the EndpointProfile Identifier of the device
EndpointProfileLocation	getLocation() Returns the Location facet of the endpoint.
java.lang.Double	getMetric(java.lang.String name) Returns the value of the metric with the specified name.
java.lang.String	getOptOut() Returns weather the endpoint is opted out of notification.
EndpointProfileUser	getUser() Returns the User facet of the endpoint.
boolean	hasAttribute(java.lang.String attributeName) Determines if this EndpointProfile contains a specific custom attribute
boolean	hasMetric(java.lang.String metricName) Determines if this EndpointProfile contains a specific metric.
void	setDemographic(EndpointProfileDemographic demographic) Sets the Demographic facet of the endpoint.
void	setEffectiveDate(long effectiveDate) Sets the effectiveDate of the endpoint.
void	setLocation(EndpointProfileLocation location) Sets the Location facet of the endpoint.
void	setUser(EndpointProfileUser user) Sets the User facet of the endpoint.
org.json.JSONObject	toJSONObject()
java.lang.String	toString()
EndpointProfile	withAttribute(java.lang.String name, java.util.List<java.lang.String> values) Adds a custom attribute to this EndpointProfile with the specified key.
EndpointProfile	withMetric(java.lang.String name, java.lang.Double value) Adds a metric to this EndpointProfile with the specified key.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EndpointProfile

public EndpointProfile(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext)

Constructor.

Parameters:

pinpointContext - the pinpoint context.

Method Detail

getApplicationId

public java.lang.String getApplicationId()

Returns the Mobile Analytics application Id

Returns:

the application id

getEndpointId

public java.lang.String getEndpointId()

Returns the EndpointProfile Identifier of the device

Returns:

the endpoint id

getChannelType

public java.lang.String getChannelType()

Returns the Channel Type of this endpoint, currently defaults to GCM

Returns:

the channel type

getAddress

public java.lang.String getAddress()

Returns the Address of the endpoint. The token that is returned by the channel selected.

Returns:

the address

getDemographic

public EndpointProfileDemographic getDemographic()

Returns the Demographic facet of the endpoint.

Returns:

EndpointProfileDemographic

setDemographic

public void setDemographic(EndpointProfileDemographic demographic)

Sets the Demographic facet of the endpoint.

Parameters:

demographic - The demographic facet.

getLocation

public EndpointProfileLocation getLocation()

Returns the Location facet of the endpoint.

Returns:

EndpointProfileLocation

setLocation

public void setLocation(EndpointProfileLocation location)

Sets the Location facet of the endpoint.

Parameters:

location - The location facet.

getEffectiveDate

public long getEffectiveDate()

Returns the effective date of the endpoint.

Returns:

long

setEffectiveDate

public void setEffectiveDate(long effectiveDate)

Sets the effectiveDate of the endpoint.

Parameters:

effectiveDate - The demographic facet.

getOptOut

public java.lang.String getOptOut()

Returns weather the endpoint is opted out of notification.

Returns:

String (ALL | NONE)

addAttribute

public void addAttribute(java.lang.String name,
                         java.util.List<java.lang.String> values)

Adds a custom attribute to this EndpointProfile with the specified key. Only 20 custom attributes/metrics are allowed to be added to a EndpointProfile. If 20 attributes already exist on this EndpointProfile, the call may be ignored.

Parameters:

name - The name of the custom attribute. The name will be truncated if it exceeds 50 characters.

values - An array of values of the custom attribute. The values will be truncated if it exceeds 100 characters.

hasAttribute

public boolean hasAttribute(java.lang.String attributeName)

Determines if this EndpointProfile contains a specific custom attribute

Parameters:

attributeName - The name of the custom attribute

Returns:

true if this EndpointProfile has a custom attribute with the specified name, false otherwise

getAttribute

public java.util.List<java.lang.String> getAttribute(java.lang.String name)

Returns the array of values of the custom attribute with the specified name.

Parameters:

name - The name of the custom attribute to return

Returns:

The array of custom attributes with the specified name, or null if attribute does not exist

withAttribute

public EndpointProfile withAttribute(java.lang.String name,
                                     java.util.List<java.lang.String> values)

Adds a custom attribute to this EndpointProfile with the specified key. Only 20 custom attributes are allowed to be added to an EndpointProfile. If 20 custom attributes/metrics already exist on this EndpointProfile, the call may be ignored.

Parameters:

name - The name of the custom attribute. The name will be truncated if it exceeds 50 characters.

values - An array of values of the custom attribute. The values will be truncated if it exceeds 100 characters.

Returns:

The same EndpointProfile instance is returned to allow for method chaining.

getAllAttributes

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllAttributes()

Returns a map of all custom attributes contained within this EndpointProfile

Returns:

a map of all custom attributes, where the attribute names are the keys and the attribute values are the values

addMetric

public void addMetric(java.lang.String name,
                      java.lang.Double value)

Adds a metric to this EndpointProfile with the specified key. Only 20 attributes/metrics are allowed to be added to an Event. If 20 attribute/metrics already exist on this Event, the call may be ignored.

Parameters:

name - The name of the metric. The name will be truncated if it exceeds 50 characters.

value - The value of the metric.

hasMetric

public boolean hasMetric(java.lang.String metricName)

Determines if this EndpointProfile contains a specific metric.

Parameters:

metricName - The name of the metric

Returns:

true if this EndpointProfile has a metric with the specified name, false otherwise

getMetric

public java.lang.Double getMetric(java.lang.String name)

Returns the value of the metric with the specified name.

Parameters:

name - The name of the metric to return

Returns:

The metric with the specified name, or null if metric does not exist

withMetric

public EndpointProfile withMetric(java.lang.String name,
                                  java.lang.Double value)

Adds a metric to this EndpointProfile with the specified key. Only 20 attributes/metrics are allowed to be added to an EndpointProfile. If 20 attribute/metrics already exist on this EndpointProfile, the call may be ignored.

Parameters:

name - The name of the metric. The name will be truncated if it exceeds 50 characters.

value - The value of the metric.

Returns:

The same EndpointProfile instance is returned to allow for method chaining.

getAllMetrics

public java.util.Map<java.lang.String,java.lang.Double> getAllMetrics()

Returns a map of all metrics contained within this EndpointProfile

Returns:

a map of all metrics, where the metric names are the keys and the metric values are the values

getUser

public EndpointProfileUser getUser()

Returns the User facet of the endpoint.

Returns:

EndpointProfileUser

setUser

public void setUser(EndpointProfileUser user)

Sets the User facet of the endpoint.

Parameters:

user - The user facet

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJSONObject

public org.json.JSONObject toJSONObject()

Specified by:

toJSONObject in interface com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable