io.micronaut.aws.alexa.flashbriefing

Class FlashBriefingItem

java.lang.Object

io.micronaut.aws.alexa.flashbriefing.FlashBriefingItem

All Implemented Interfaces:

java.lang.Comparable<FlashBriefingItem>

@Introspected
public class FlashBriefingItem
extends java.lang.Object
implements java.lang.Comparable<FlashBriefingItem>

Flash Briefing item.

Since:

2.0.0

Author:

sdelamo

See Also:

Flash Breifing Skill API Feed Reference

Constructor Summary

Constructors

Constructor and Description
FlashBriefingItem() Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(FlashBriefingItem o) Flash briefing items should be provided in order from newest to oldest, based on the date value for the item.
java.lang.String	getMainText()
java.lang.String	getRedirectionUrl()
java.lang.String	getStreamUrl()
java.lang.String	getTitleText()
java.lang.String	getUid()
java.time.ZonedDateTime	getUpdateDate()
void	setMainText(java.lang.String mainText)
void	setRedirectionUrl(java.lang.String redirectionUrl)
void	setStreamUrl(java.lang.String streamUrl)
void	setTitleText(java.lang.String titleText)
void	setUid(java.lang.String uid)
void	setUpdateDate(java.time.ZonedDateTime updateDate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlashBriefingItem

public FlashBriefingItem()

Constructor.

Method Detail

getUid

@NonNull
public java.lang.String getUid()

Returns:

A unique identifier for the feed item.

setUid

public void setUid(@NonNull
                   java.lang.String uid)

Parameters:

uid - A unique identifier for the feed item

getUpdateDate

@NonNull
public java.time.ZonedDateTime getUpdateDate()

Returns:

The date that indicates the freshness of the feed item

setUpdateDate

public void setUpdateDate(@NonNull
                          java.time.ZonedDateTime updateDate)

Parameters:

updateDate - the date that indicates the freshness of the feed item

getTitleText

@NonNull
public java.lang.String getTitleText()

Returns:

The title of the feed item to display in the alexa app.

setTitleText

public void setTitleText(@NonNull
                         java.lang.String titleText)

Parameters:

titleText - Title of the feed item to display in the alexa app.

getMainText

@NonNull
public java.lang.String getMainText()

Returns:

The text that alexa read to the customer.

setMainText

public void setMainText(@NonNull
                        java.lang.String mainText)

Parameters:

mainText - The text that alexa read to the customer.

getStreamUrl

@Nullable
public java.lang.String getStreamUrl()

Returns:

The HTTPs URL specifying the location of the audio content.

setStreamUrl

public void setStreamUrl(@Nullable
                         java.lang.String streamUrl)

Parameters:

streamUrl - Sets an HTTPs URL specifying the location of the audio content.

getRedirectionUrl

@NonNull
public java.lang.String getRedirectionUrl()

Returns:

the url target for the Read more link in he alexa app.

setRedirectionUrl

public void setRedirectionUrl(@NonNull
                              java.lang.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 java.lang.Comparable<FlashBriefingItem>

Parameters:

o - Flash briefing item being compared to

Returns:

comparison results based on updateDate.