com.amazonaws.mobileconnectors.pinpoint.targeting

Class TargetingClient

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.targeting.TargetingClient

public class TargetingClient
extends java.lang.Object

Client to manage updating the endpoint profile

Constructor Summary

Constructors

Constructor and Description
TargetingClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context) Initializes a client to manage updating the endpoint profile
TargetingClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context, java.util.concurrent.ExecutorService executor) Initializes a targetingClient used for testing only

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String attributeName, java.util.List<java.lang.String> attributeValues) Adds the specified attribute to the current endpoint profile generated by this client.
void	addMetric(java.lang.String metricName, java.lang.Double metricValue) Adds the specified metric to the current endpoint profile generated by this client.
EndpointProfile	currentEndpoint() Returns the device endpoint profile.
void	removeAttribute(java.lang.String attributeName) Removes the specified attribute.
void	removeMetric(java.lang.String metricName) Removes the specified metric from the current endpoint profile generated by this client.
void	updateEndpointProfile() Register the current endpoint with the Pinpoint service.
void	updateEndpointProfile(EndpointProfile endpointProfile) Register the provided endpoint with the Pinpoint service.

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetingClient

public TargetingClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context,
                       java.util.concurrent.ExecutorService executor)

Initializes a targetingClient used for testing only

Parameters:

context - The PinpointContext

executor - A thread pool executor

TargetingClient

public TargetingClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context)

Initializes a client to manage updating the endpoint profile

Parameters:

context - The PinpointContext

Method Detail

currentEndpoint

public EndpointProfile currentEndpoint()

Returns the device endpoint profile. TargetingClient attributes and Metrics are added to the endpoint profile.

Returns:

The current device endpoint profile

updateEndpointProfile

public void updateEndpointProfile()

Register the current endpoint with the Pinpoint service. TargetingClient attributes and Metrics are added to the endpoint profile.

updateEndpointProfile

public void updateEndpointProfile(EndpointProfile endpointProfile)

Register the provided endpoint with the Pinpoint service. TargetingClient attributes and Metrics are added to the endpoint profile.

Parameters:

endpointProfile - An instance of an EndpointProfile to be updated

addAttribute

public void addAttribute(java.lang.String attributeName,
                         java.util.List<java.lang.String> attributeValues)

Adds the specified attribute to the current endpoint profile generated by this client. Note: The maximum allowed attributes/metrics is 20. Attempts to add more may be ignored

Parameters:

attributeName - the name of the attribute to add

attributeValues - the value of the attribute

removeAttribute

public void removeAttribute(java.lang.String attributeName)

Removes the specified attribute. All subsequently created events will no longer have this global attribute. from the current endpoint profile generated by this client.

Parameters:

attributeName - the name of the attribute to remove

addMetric

public void addMetric(java.lang.String metricName,
                      java.lang.Double metricValue)

Adds the specified metric to the current endpoint profile generated by this client. Note: The maximum allowed attributes and metrics on an endpoint update is 20. Attempts to add more may be ignored

Parameters:

metricName - the name of the metric to add

metricValue - the value of the metric

removeMetric

public void removeMetric(java.lang.String metricName)

Removes the specified metric from the current endpoint profile generated by this client.

Parameters:

metricName - the name of the metric to remove