PublicEndpoint

Specifies the properties and attributes of an endpoint that's associated with an event.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

Link copied to clipboard

One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

Link copied to clipboard

The channel that's used when sending messages or push notifications to the endpoint.

Link copied to clipboard

The demographic information for the endpoint, such as the time zone and platform.

Link copied to clipboard

The date and time, in ISO 8601 format, when the endpoint was last updated.

Link copied to clipboard

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Link copied to clipboard

The geographic information for the endpoint.

Link copied to clipboard

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

Link copied to clipboard

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

Link copied to clipboard

A unique identifier that's generated each time the endpoint is updated.

Link copied to clipboard

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

Functions

Link copied to clipboard
inline fun copy(block: PublicEndpoint.Builder.() -> Unit = {}): PublicEndpoint
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String