Creates an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
Declaration Syntax
C# |
public class CreatePlatformEndpointRequest : SNSRequest
Members
All Members | Constructors | Methods | Properties | ||
Icon | Member | Description |
---|---|---|
CreatePlatformEndpointRequest()()()() | Initializes a new instance of the CreatePlatformEndpointRequest class | |
Attributes |
Gets or sets the attributes.
| |
CustomUserData |
Arbitrary user data to associate with the endpoint. SNS does not use this data.
The data must be in UTF-8 format and less than 2KB.
| |
Equals(Object) | (Inherited from Object.) | |
GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType()()()() | Gets the type of the current instance. (Inherited from Object.) | |
IsSetAttributes()()()() |
Determines whether the target [P:Attributes] is set in this request.
| |
IsSetCustomUserData()()()() |
Determines whether the CustomUserData property is set.
| |
IsSetPlatformApplicationArn()()()() |
Determines whether the [P:PlatformApplicationArn] property is set.
| |
IsSetToken()()()() |
Determines whether the [P:Token] property is set.
| |
PlatformApplicationArn |
Gets or sets the platform application ARN.
| |
Token |
Unique identifier created by the notification service for an app on a device.
The specific name for Token will vary, depending on which notification service is being used.
For example, when using APNS as the notification service, you need the device token.
Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
| |
ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) | |
WithAttribute(String, String) | Obsolete.
Modifies this request to include the specified attribute. If an attribute already exists,
its value will be replaced with the new value.
| |
WithAttributes(Dictionary<(Of <<'(String, String>)>>)) | Obsolete.
Modifies this request with the specified attributes.
| |
WithCustomUserData(String) | Obsolete.
Modifies the custom user data in this request instance.
| |
WithPlatformApplicationArn(String) | Obsolete.
Modifies the platform application ARN in this request instance.
| |
WithToken(String) | Obsolete.
Modifies the token in this request instance.
|
Remarks
This method requires the PlatformApplicationArn that is returned from CreatePlatformApplication(CreatePlatformApplicationRequest).
The EndpointArn that is returned when using this method can then be used by the Publish(PublishRequest) method to
send a message to a mobile app or by the Subscribe(SubscribeRequest) action for subscription to a topic.
For more information, see Using Amazon SNS Mobile Push Notifications.
Inheritance Hierarchy
Object | ||
SNSRequest | ||
CreatePlatformEndpointRequest |