Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.InAppMessageCampaign

Description

Synopsis

data InAppMessageCampaign = InAppMessageCampaign' {
- sessionCap :: Maybe Int
- priority :: Maybe Int
- schedule :: Maybe InAppCampaignSchedule
- campaignId :: Maybe Text
- treatmentId :: Maybe Text
- inAppMessage :: Maybe InAppMessage
- totalCap :: Maybe Int
- dailyCap :: Maybe Int
}
newInAppMessageCampaign :: InAppMessageCampaign
inAppMessageCampaign_sessionCap :: Lens' InAppMessageCampaign (Maybe Int)
inAppMessageCampaign_priority :: Lens' InAppMessageCampaign (Maybe Int)
inAppMessageCampaign_schedule :: Lens' InAppMessageCampaign (Maybe InAppCampaignSchedule)
inAppMessageCampaign_campaignId :: Lens' InAppMessageCampaign (Maybe Text)
inAppMessageCampaign_treatmentId :: Lens' InAppMessageCampaign (Maybe Text)
inAppMessageCampaign_inAppMessage :: Lens' InAppMessageCampaign (Maybe InAppMessage)
inAppMessageCampaign_totalCap :: Lens' InAppMessageCampaign (Maybe Int)
inAppMessageCampaign_dailyCap :: Lens' InAppMessageCampaign (Maybe Int)

Documentation

data InAppMessageCampaign Source #

Targeted in-app message campaign.

See: newInAppMessageCampaign smart constructor.

Constructors

InAppMessageCampaign'

Fields

sessionCap :: Maybe Int
Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
priority :: Maybe Int
Priority of the in-app message.
schedule :: Maybe InAppCampaignSchedule
Schedule of the campaign.
campaignId :: Maybe Text
Campaign id of the corresponding campaign.
treatmentId :: Maybe Text
Treatment id of the campaign.
inAppMessage :: Maybe InAppMessage
In-app message content with all fields required for rendering an in-app message.
totalCap :: Maybe Int
Total cap which controls the number of times an in-app message can be shown to the endpoint.
dailyCap :: Maybe Int
Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

Instances

Instances details

Eq InAppMessageCampaign Source #
Instance details Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign Methods (==) :: InAppMessageCampaign -> InAppMessageCampaign -> Bool # (/=) :: InAppMessageCampaign -> InAppMessageCampaign -> Bool #
Read InAppMessageCampaign Source #
Instance details Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign Methods readsPrec :: Int -> ReadS InAppMessageCampaign # readList :: ReadS [InAppMessageCampaign] # readPrec :: ReadPrec InAppMessageCampaign # readListPrec :: ReadPrec [InAppMessageCampaign] #
Show InAppMessageCampaign Source #
Instance details Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign Methods showsPrec :: Int -> InAppMessageCampaign -> ShowS # show :: InAppMessageCampaign -> String # showList :: [InAppMessageCampaign] -> ShowS #
Generic InAppMessageCampaign Source #
Instance details Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign Associated Types type Rep InAppMessageCampaign :: Type -> Type # Methods from :: InAppMessageCampaign -> Rep InAppMessageCampaign x # to :: Rep InAppMessageCampaign x -> InAppMessageCampaign #
NFData InAppMessageCampaign Source #
Instance details Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign Methods rnf :: InAppMessageCampaign -> () #
Hashable InAppMessageCampaign Source #
Instance details Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign Methods hashWithSalt :: Int -> InAppMessageCampaign -> Int # hash :: InAppMessageCampaign -> Int #
FromJSON InAppMessageCampaign Source #
Instance details Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign Methods parseJSON :: Value -> Parser InAppMessageCampaign # parseJSONList :: Value -> Parser [InAppMessageCampaign] #
type Rep InAppMessageCampaign Source #
Instance details Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign type Rep InAppMessageCampaign = D1 ('MetaData "InAppMessageCampaign" "Amazonka.Pinpoint.Types.InAppMessageCampaign" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "InAppMessageCampaign'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sessionCap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InAppCampaignSchedule)) :: S1 ('MetaSel ('Just "campaignId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "treatmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "inAppMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InAppMessage))) :: (S1 ('MetaSel ('Just "totalCap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "dailyCap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newInAppMessageCampaign :: InAppMessageCampaign Source #

Create a value of InAppMessageCampaign with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sessionCap:InAppMessageCampaign', inAppMessageCampaign_sessionCap - Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

$sel:priority:InAppMessageCampaign', inAppMessageCampaign_priority - Priority of the in-app message.

$sel:schedule:InAppMessageCampaign', inAppMessageCampaign_schedule - Schedule of the campaign.

$sel:campaignId:InAppMessageCampaign', inAppMessageCampaign_campaignId - Campaign id of the corresponding campaign.

$sel:treatmentId:InAppMessageCampaign', inAppMessageCampaign_treatmentId - Treatment id of the campaign.

$sel:inAppMessage:InAppMessageCampaign', inAppMessageCampaign_inAppMessage - In-app message content with all fields required for rendering an in-app message.

$sel:totalCap:InAppMessageCampaign', inAppMessageCampaign_totalCap - Total cap which controls the number of times an in-app message can be shown to the endpoint.

$sel:dailyCap:InAppMessageCampaign', inAppMessageCampaign_dailyCap - Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

inAppMessageCampaign_sessionCap :: Lens' InAppMessageCampaign (Maybe Int) Source #

Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

inAppMessageCampaign_priority :: Lens' InAppMessageCampaign (Maybe Int) Source #

Priority of the in-app message.

inAppMessageCampaign_schedule :: Lens' InAppMessageCampaign (Maybe InAppCampaignSchedule) Source #

Schedule of the campaign.

inAppMessageCampaign_campaignId :: Lens' InAppMessageCampaign (Maybe Text) Source #

Campaign id of the corresponding campaign.

inAppMessageCampaign_treatmentId :: Lens' InAppMessageCampaign (Maybe Text) Source #

Treatment id of the campaign.

inAppMessageCampaign_inAppMessage :: Lens' InAppMessageCampaign (Maybe InAppMessage) Source #

In-app message content with all fields required for rendering an in-app message.

inAppMessageCampaign_totalCap :: Lens' InAppMessageCampaign (Maybe Int) Source #

Total cap which controls the number of times an in-app message can be shown to the endpoint.

inAppMessageCampaign_dailyCap :: Lens' InAppMessageCampaign (Maybe Int) Source #

Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.