MamdaNewsStory represents a complete text of a news story.
More...
#include <MamdaNewsStory.h>
|
static Status | toStatus (const char *strVal) |
| Convert a string representation of a Status to the enumerated representation. More...
|
|
static const char * | toString (Status status) |
| Convert an enumerated representation of a Status to a string representation. More...
|
|
MamdaNewsStory represents a complete text of a news story.
◆ Status
The Status enumeration provides information about the status of the news story and is provided in responses to news story requests.
NO_STORY indicates that there is currently no story for the headline. This may occur for feeds that provide "alert" headlines, either as the only headline or as a precursor to a full story.
FULL_STORY indicates that the complete story text is being provided in the current callback.
FETCHING_STORY indicates that the story is currently being fetched by the publisher. This is a temporary status. An additional callback will automatically be invoked when the full story is available.
DELAYED_STORY indicates that the story is not currently available but is expected at some time in the future. No additional callback will be automatically invoked.
NOT_FOUND indicates that the publisher does not currently have a story for this headline and cannot determine whether a story will arrive for the headline. No additional callback will be automatically invoked.
UNKNOWN indicates an unknown condition (should not happen).
Enumerator |
---|
NO_STORY | |
FULL_STORY | |
FETCHING_STORY | |
DELAYED_STORY | |
NOT_FOUND | |
DELETED | |
EXPIRED | |
UNKNOWN | |
Definition: MamdaNewsStory.h:70
Definition: MamdaNewsStory.h:73
Definition: MamdaNewsStory.h:76
Definition: MamdaNewsStory.h:71
Definition: MamdaNewsStory.h:74
Definition: MamdaNewsStory.h:77
Definition: MamdaNewsStory.h:72
Definition: MamdaNewsStory.h:75
◆ MamdaNewsStory() [1/2]
Wombat::MamdaNewsStory::MamdaNewsStory |
( |
| ) |
|
◆ MamdaNewsStory() [2/2]
◆ ~MamdaNewsStory()
virtual Wombat::MamdaNewsStory::~MamdaNewsStory |
( |
| ) |
|
|
virtual |
◆ operator=()
◆ setStory()
virtual void Wombat::MamdaNewsStory::setStory |
( |
const char * |
storyText, |
|
|
const char * |
storyId, |
|
|
uint16_t |
storyRevNum, |
|
|
Status |
storyStatus, |
|
|
const MamaDateTime & |
storyTime, |
|
|
const MamaDateTime & |
storyOrigTime, |
|
|
const MamdaNewsHeadlineId * |
headlines, |
|
|
mama_size_t |
numHeadlines |
|
) |
| |
|
virtual |
Set all of the news story attributes.
◆ setNewsStoryText()
virtual void Wombat::MamdaNewsStory::setNewsStoryText |
( |
const char * |
storyText | ) |
|
|
virtual |
◆ getNewsStoryText()
virtual const char* Wombat::MamdaNewsStory::getNewsStoryText |
( |
| ) |
const |
|
virtual |
- Returns
- The text of the story.
◆ setNewsStoryId()
◆ getNewsStoryId()
- Returns
- The unique (for the data source) story ID for this news story.
◆ setNewsStoryRevNumber()
virtual void Wombat::MamdaNewsStory::setNewsStoryRevNumber |
( |
uint16_t |
storyRevNum | ) |
|
|
virtual |
Set the story revision number.
◆ getNewsStoryRevNumber()
virtual uint16_t Wombat::MamdaNewsStory::getNewsStoryRevNumber |
( |
| ) |
const |
|
virtual |
- Returns
- The revision number. Note: the value returned is zero if the data source does not provide revision numbers.
◆ setStatus()
virtual void Wombat::MamdaNewsStory::setStatus |
( |
Status |
status | ) |
|
|
virtual |
◆ getStatus()
virtual Status Wombat::MamdaNewsStory::getStatus |
( |
| ) |
const |
|
virtual |
◆ getStoryTime()
virtual const MamaDateTime& Wombat::MamdaNewsStory::getStoryTime |
( |
| ) |
const |
|
virtual |
- Returns
- The latest story update time (e.g. time of correction).
◆ getOrigStoryTime()
virtual const MamaDateTime& Wombat::MamdaNewsStory::getOrigStoryTime |
( |
| ) |
const |
|
virtual |
- Returns
- The original story publish time.
◆ getHeadlines()
virtual void Wombat::MamdaNewsStory::getHeadlines |
( |
const MamdaNewsHeadlineId *& |
headlines, |
|
|
mama_size_t & |
numHeadlines |
|
) |
| const |
|
virtual |
- Returns
- All of the headline IDs associated with this news story.
◆ toStatus()
static Status Wombat::MamdaNewsStory::toStatus |
( |
const char * |
strVal | ) |
|
|
static |
Convert a string representation of a Status to the enumerated representation.
◆ toString()
static const char* Wombat::MamdaNewsStory::toString |
( |
Status |
status | ) |
|
|
static |
Convert an enumerated representation of a Status to a string representation.
◆ setSubscInfo()
void Wombat::MamdaNewsStory::setSubscInfo |
( |
MamaQueue * |
queue, |
|
|
MamaSource * |
source |
|
) |
| |
◆ getQueue()
MamaQueue* Wombat::MamdaNewsStory::getQueue |
( |
| ) |
const |
◆ getSource()
MamaSource* Wombat::MamdaNewsStory::getSource |
( |
| ) |
const |
The documentation for this class was generated from the following file: