Interface InAppMessageCampaign.Builder

All Superinterfaces:
Buildable, CopyableBuilder<InAppMessageCampaign.Builder,InAppMessageCampaign>, SdkBuilder<InAppMessageCampaign.Builder,InAppMessageCampaign>, SdkPojo
Enclosing class:
InAppMessageCampaign
@Mutable @NotThreadSafe public static interface InAppMessageCampaign.Builder extends SdkPojo, CopyableBuilder<InAppMessageCampaign.Builder,InAppMessageCampaign>

  • Method Details

    • campaignId

      InAppMessageCampaign.Builder campaignId(String campaignId)

      Campaign id of the corresponding campaign.

      Parameters:
      campaignId - Campaign id of the corresponding campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dailyCap

      InAppMessageCampaign.Builder dailyCap(Integer dailyCap)

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

      Parameters:
      dailyCap - Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inAppMessage

      InAppMessageCampaign.Builder inAppMessage(InAppMessage inAppMessage)

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

      Parameters:
      inAppMessage - In-app message content with all fields required for rendering an in-app message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inAppMessage

      default InAppMessageCampaign.Builder inAppMessage(Consumer<InAppMessage.Builder> inAppMessage)

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

      This is a convenience method that creates an instance of the InAppMessage.Builder avoiding the need to create one manually via InAppMessage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inAppMessage(InAppMessage).

      Parameters:
      inAppMessage - a consumer that will call methods on InAppMessage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • priority

      InAppMessageCampaign.Builder priority(Integer priority)

      Priority of the in-app message.

      Parameters:
      priority - Priority of the in-app message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedule

      InAppMessageCampaign.Builder schedule(InAppCampaignSchedule schedule)

      Schedule of the campaign.

      Parameters:
      schedule - Schedule of the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedule

      default InAppMessageCampaign.Builder schedule(Consumer<InAppCampaignSchedule.Builder> schedule)

      Schedule of the campaign.

      This is a convenience method that creates an instance of the InAppCampaignSchedule.Builder avoiding the need to create one manually via InAppCampaignSchedule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(InAppCampaignSchedule).

      Parameters:
      schedule - a consumer that will call methods on InAppCampaignSchedule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sessionCap

      InAppMessageCampaign.Builder sessionCap(Integer sessionCap)

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

      Parameters:
      sessionCap - Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalCap

      InAppMessageCampaign.Builder totalCap(Integer totalCap)

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

      Parameters:
      totalCap - Total cap which controls the number of times an in-app message can be shown to the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatmentId

      InAppMessageCampaign.Builder treatmentId(String treatmentId)

      Treatment id of the campaign.

      Parameters:
      treatmentId - Treatment id of the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.