SuperTweet interface driver classes.
Dependents: SuperTweet_TestProgram StarBoardOrangeExpansion1 GSL_04-Network_Twitter
Diff: SuperTweetV1XML.h
- Revision:
- 1:2d211e591fc8
- Parent:
- 0:d48d92e6c145
- Child:
- 2:d463d3fc4f81
--- a/SuperTweetV1XML.h Tue Oct 12 22:20:38 2010 +0000 +++ b/SuperTweetV1XML.h Thu Oct 28 12:02:05 2010 +0000 @@ -7,12 +7,49 @@ #include "SuperTweet.h" +/** + * SuperTweet driver class. + */ class SuperTweetV1XML : public SuperTweet { public: + + /** + * Create. + * + * @param account Account name. + * @param password Password. + */ SuperTweetV1XML(const std::string account, const std::string password); + + /** + * Dispose. + */ virtual ~SuperTweetV1XML(); + + /** + * Returns the 20 most recent statuses posted by the authenticating user. + * + * @param func A pointer to a callback function. + * @return Result code. + */ virtual HTTPResult getStatusesUserTimeline(void (*func)(char *buf, size_t siz)); + + /** + * Returns the 20 most recent statuses, including retweets if they exist, posted by the authenticating user and the user's they follow. + * + * @param func A pointer to a callback function. + * @return Result code. + */ virtual HTTPResult getStatusesHomeTimeline(void (*func)(char *buf, size_t siz)); + + /** + * Updates the authenticating user's status. + * A status update with text identical to the authenticating user's text identical + * to the authenticating user's current status will be ignored to prevent duplicates. + * + * @param func A pointer to a callback function. + * @return Result code. + */ virtual HTTPResult postStatusesUpdate(const std::string datatext, void (*func)(char *buf, size_t siz)); private: HTTPResult result;