Package io.micronaut.aws.alexa.flashbriefing

Class FlashBriefingItem

java.lang.Object
io.micronaut.aws.alexa.flashbriefing.FlashBriefingItem
All Implemented Interfaces:
Comparable<FlashBriefingItem>
@Introspected public class FlashBriefingItem extends Object implements Comparable<FlashBriefingItem>
Flash Briefing item.
Since:
2.0.0
Author:
sdelamo
See Also:

  • Constructor Details

    • FlashBriefingItem

      public FlashBriefingItem()
      Constructor.

  • Method Details

    • getUid

      @NonNull public @NonNull String getUid()
      Returns:
      A unique identifier for the feed item.

    • setUid

      public void setUid(@NonNull @NonNull String uid)
      Parameters:
      uid - A unique identifier for the feed item

    • getUpdateDate

      @NonNull public @NonNull ZonedDateTime getUpdateDate()
      Returns:
      The date that indicates the freshness of the feed item

    • setUpdateDate

      public void setUpdateDate(@NonNull @NonNull ZonedDateTime updateDate)
      Parameters:
      updateDate - the date that indicates the freshness of the feed item

    • getTitleText

      @NonNull public @NonNull String getTitleText()
      Returns:
      The title of the feed item to display in the alexa app.

    • setTitleText

      public void setTitleText(@NonNull @NonNull String titleText)
      Parameters:
      titleText - Title of the feed item to display in the alexa app.

    • getMainText

      @NonNull public @NonNull String getMainText()
      Returns:
      The text that alexa read to the customer.

    • setMainText

      public void setMainText(@NonNull @NonNull String mainText)
      Parameters:
      mainText - The text that alexa read to the customer.

    • getStreamUrl

      @Nullable public @Nullable String getStreamUrl()
      Returns:
      The HTTPs URL specifying the location of the audio content.

    • setStreamUrl

      public void setStreamUrl(@Nullable @Nullable String streamUrl)
      Parameters:
      streamUrl - Sets an HTTPs URL specifying the location of the audio content.

    • getRedirectionUrl

      @NonNull public @NonNull String getRedirectionUrl()
      Returns:
      the url target for the Read more link in he alexa app.

    • setRedirectionUrl

      public void setRedirectionUrl(@NonNull @NonNull String redirectionUrl)
      Parameters:
      redirectionUrl - Sets the url target for the Read more link in he alexa app.

    • compareTo

      public int compareTo(FlashBriefingItem o)
      Flash briefing items should be provided in order from newest to oldest, based on the date value for the item. Alexa may ignore older items.
      Specified by:
      compareTo in interface Comparable<FlashBriefingItem>
      Parameters:
      o - Flash briefing item being compared to
      Returns:
      comparison results based on updateDate.