AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.Pinpoint.Model.PublicEndpoint

Namespace: Amazon.Pinpoint.Model
Assembly: AWSSDK.Pinpoint.dll
Version: 3.x.y.z

Syntax

C#
public class PublicEndpoint

The PublicEndpoint type exposes the following members

Constructors

NameDescription
Public Method PublicEndpoint()

Properties

NameTypeDescription
Public Property Address System.String

Gets and sets the property Address.

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

Public Property Attributes System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Gets and sets the property Attributes.

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.

Public Property ChannelType Amazon.Pinpoint.ChannelType

Gets and sets the property ChannelType.

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

Public Property Demographic Amazon.Pinpoint.Model.EndpointDemographic

Gets and sets the property Demographic.

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

Public Property EffectiveDate System.String

Gets and sets the property EffectiveDate.

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

Public Property EndpointStatus System.String

Gets and sets the property EndpointStatus.

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.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

Public Property Location Amazon.Pinpoint.Model.EndpointLocation

Gets and sets the property Location.

The geographic information for the endpoint.

Public Property Metrics System.Collections.Generic.Dictionary<System.String, System.Double>

Gets and sets the property Metrics.

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

Public Property OptOut System.String

Gets and sets the property OptOut.

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.

Public Property RequestId System.String

Gets and sets the property RequestId.

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

Public Property User Amazon.Pinpoint.Model.EndpointUser

Gets and sets the property User.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5