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 schedule settings for a campaign.

Inheritance Hierarchy

System.Object
  Amazon.Pinpoint.Model.Schedule

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

Syntax

C#
public class Schedule

The Schedule type exposes the following members

Constructors

NameDescription
Public Method Schedule()

Properties

NameTypeDescription
Public Property EndTime System.String

Gets and sets the property EndTime.

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

Public Property EventFilter Amazon.Pinpoint.Model.CampaignEventFilter

Gets and sets the property EventFilter.

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

Public Property Frequency Amazon.Pinpoint.Frequency

Gets and sets the property Frequency.

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

Public Property IsLocalTime System.Boolean

Gets and sets the property IsLocalTime.

Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

Public Property QuietTime Amazon.Pinpoint.Model.QuietTime

Gets and sets the property QuietTime.

The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

  • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

  • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

Public Property StartTime System.String

Gets and sets the property StartTime.

The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

Public Property Timezone System.String

Gets and sets the property Timezone.

The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

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