CampaignResponse class
Provides information about the status, configuration, and other settings for a campaign.
Constructors
-
CampaignResponse({required String applicationId, required String arn, required String creationDate, required String id, required String lastModifiedDate, required String segmentId, required int segmentVersion, List<
TreatmentResource> ? additionalTreatments, CustomDeliveryConfiguration? customDeliveryConfiguration, CampaignState? defaultState, String? description, int? holdoutPercent, CampaignHook? hook, bool? isPaused, CampaignLimits? limits, MessageConfiguration? messageConfiguration, String? name, Schedule? schedule, CampaignState? state, TemplateConfiguration? templateConfiguration, String? treatmentDescription, String? treatmentName, int? version, Map<String, String> ? tags}) -
CampaignResponse.fromJson(Map<
String, dynamic> json) -
factory
Properties
-
additionalTreatments
→ List<
TreatmentResource> ? -
An array of responses, one for each treatment that you defined for the
campaign, in addition to the default treatment.
final
- applicationId → String
-
The unique identifier for the application that the campaign applies to.
final
- arn → String
-
The Amazon Resource Name (ARN) of the campaign.
final
- creationDate → String
-
The date, in ISO 8601 format, when the campaign was created.
final
- customDeliveryConfiguration → CustomDeliveryConfiguration?
-
The delivery configuration settings for sending the campaign through a
custom channel.
final
- defaultState → CampaignState?
-
The current status of the campaign's default treatment. This value exists
only for campaigns that have more than one treatment.
final
- description → String?
-
The custom description of the campaign.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- holdoutPercent → int?
-
The allocated percentage of users (segment members) who shouldn't receive
messages from the campaign.
final
- hook → CampaignHook?
-
The settings for the AWS Lambda function to use as a code hook for the
campaign. You can use this hook to customize the segment that's used by the
campaign.
final
- id → String
-
The unique identifier for the campaign.
final
- isPaused → bool?
-
Specifies whether the campaign is paused. A paused campaign doesn't run
unless you resume it by changing this value to false.
final
- lastModifiedDate → String
-
The date, in ISO 8601 format, when the campaign was last modified.
final
- limits → CampaignLimits?
-
The messaging limits for the campaign.
final
- messageConfiguration → MessageConfiguration?
-
The message configuration settings for the campaign.
final
- name → String?
-
The name of the campaign.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- schedule → Schedule?
-
The schedule settings for the campaign.
final
- segmentId → String
-
The unique identifier for the segment that's associated with the campaign.
final
- segmentVersion → int
-
The version number of the segment that's associated with the campaign.
final
- state → CampaignState?
-
The current status of the campaign.
final
-
A string-to-string map of key-value pairs that identifies the tags that are
associated with the campaign. Each tag consists of a required tag key and an
associated tag value.
final
- templateConfiguration → TemplateConfiguration?
-
The message template that’s used for the campaign.
final
- treatmentDescription → String?
-
The custom description of the default treatment for the campaign.
final
- treatmentName → String?
-
The custom name of the default treatment for the campaign, if the campaign
has multiple treatments. A treatment is a variation of a campaign
that's used for A/B testing.
final
- version → int?
-
The version number of the campaign.
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