EndpointRequest class

Specifies the channel type and other settings for an endpoint.

Constructors

EndpointRequest({String? address, Map<String, List<String>>? attributes, ChannelType? channelType, EndpointDemographic? demographic, String? effectiveDate, String? endpointStatus, EndpointLocation? location, Map<String, double>? metrics, String? optOut, String? requestId, EndpointUser? user})

Properties

address String?
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
final
attributes Map<String, List<String>>?
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: "Science", "Music", "Travel". You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
final
channelType ChannelType?
The channel to use when sending messages or push notifications to the endpoint.
final
demographic EndpointDemographic?
The demographic information for the endpoint, such as the time zone and platform.
final
effectiveDate String?
The date and time, in ISO 8601 format, when the endpoint is updated.
final
endpointStatus String?
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.
final
hashCode int
The hash code for this object.
no setterinherited
location EndpointLocation?
The geographic information for the endpoint.
final
metrics Map<String, double>?
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
final
optOut String?
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.
final
requestId String?
The unique identifier for the most recent request to update the endpoint.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
user EndpointUser?
One or more custom attributes that describe the user who's associated with the endpoint.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited