ListEndpointsByPlatformApplicationRequest Class

Container for the parameters to the ListEndpointsByPlatformApplication operation. Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceRequest
      Amazon.SimpleNotificationService.Model.ListEndpointsByPlatformApplicationRequest

Namespace: Amazon.SimpleNotificationService.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

public class ListEndpointsByPlatformApplicationRequest : AmazonSimpleNotificationServiceRequest
         IRequestEvents

The ListEndpointsByPlatformApplicationRequest type exposes the following members

Constructors

	Name	Description
	ListEndpointsByPlatformApplicationRequest()

Properties

	Name	Type	Description
	NextToken	System.String	Gets and sets the property NextToken. NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
	PlatformApplicationArn	System.String	Gets and sets the property PlatformApplicationArn. PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

Examples

This example shows how to list all mobile push applications and their attributes. For each mobile push application, this example also lists its endpoints and their attributes.

List mobile push applications and endpoints example

var snsClient = new AmazonSimpleNotificationServiceClient();
var appsResponse = snsClient.ListPlatformApplications();

foreach (var app in appsResponse.PlatformApplications)
{
  Console.WriteLine();

  var appAttrsRequest = new GetPlatformApplicationAttributesRequest
  {
    PlatformApplicationArn = app.PlatformApplicationArn
  };

  var appAttrsResponse =
    snsClient.GetPlatformApplicationAttributes(appAttrsRequest);

  var endpointsByAppRequest =
    new ListEndpointsByPlatformApplicationRequest
    {
      PlatformApplicationArn = app.PlatformApplicationArn
    };

  var endpointsByAppResponse =
    snsClient.ListEndpointsByPlatformApplication(
    endpointsByAppRequest);

  Console.WriteLine("Application: " + app.PlatformApplicationArn);
  Console.WriteLine("  Properties: ");

  foreach (var attr in appAttrsResponse.Attributes)
  {
    Console.WriteLine("    " + attr.Key + ": " + attr.Value);
  }

  Console.WriteLine("  Endpoints: ");

  foreach (var endpoint in endpointsByAppResponse.Endpoints)
  {
    Console.WriteLine("     ARN: " + endpoint.EndpointArn);
    Console.WriteLine("     Attributes: ");

    foreach (var attr in endpoint.Attributes)
    {
      Console.WriteLine("       " + attr.Key + ": " + attr.Value);
    }
  }
}

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8