EndpointResponse class
Provides information about the channel type and other settings for an endpoint.
Constructors
-
EndpointResponse({String? address, String? applicationId, Map<
String, List< ? attributes, ChannelType? channelType, String? cohortId, String? creationDate, EndpointDemographic? demographic, String? effectiveDate, String? endpointStatus, String? id, EndpointLocation? location, Map<String> >String, double> ? metrics, String? optOut, String? requestId, EndpointUser? user}) -
EndpointResponse.fromJson(Map<
String, dynamic> json) -
factory
Properties
- address → String?
-
The destination address for messages or push notifications that you send to
the endpoint. The address varies by channel. For example, the address for a
push-notification channel is typically the token provided by a push
notification service, such as an Apple Push Notification service (APNs)
device token or a Firebase Cloud Messaging (FCM) registration token. The
address for the SMS channel is a phone number in E.164 format, such as
+12065550100. The address for the email channel is an email address.
final
- applicationId → String?
-
The unique identifier for the application that's associated with the
endpoint.
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.final - channelType → ChannelType?
-
The channel that's used when sending messages or push notifications to the
endpoint.
final
- cohortId → String?
-
A number from 0-99 that represents the cohort that the endpoint is assigned
to. Endpoints are grouped into cohorts randomly, and each cohort contains
approximately 1 percent of the endpoints for an application. Amazon Pinpoint
assigns cohorts to the holdout or treatment allocations for campaigns.
final
- creationDate → String?
-
The date and time, in ISO 8601 format, when the endpoint was created.
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 was last updated.
final
- endpointStatus → String?
-
Specifies whether messages or push notifications are sent to the endpoint.
Possible 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
- id → String?
-
The unique identifier that you assigned to the endpoint. The identifier
should be a globally unique identifier (GUID) to ensure that it doesn't
conflict with other endpoint identifiers that are associated with the
application.
final
- 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 user attributes that your app reports to Amazon Pinpoint
for the user who's associated with the endpoint.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited