SuperTweet interface driver classes.

Dependents:   SuperTweet_TestProgram StarBoardOrangeExpansion1 GSL_04-Network_Twitter

Embed: (wiki syntax)

« Back to documentation index

SuperTweet Class Reference

SuperTweet API interface driver. More...

#include <SuperTweet.h>

Inherited by SuperTweetV1XML.

Public Member Functions

 SuperTweet (const std::string account, const std::string password)
 Create.
virtual ~SuperTweet ()
 Dispose.
void setTimeout (int ms)
 Set timeout.
virtual HTTPResult getStatusesUserTimeline (void(*func)(char *buf, size_t siz)=NULL)=0
 Returns the 20 most recent statuses posted by the authenticating user.
virtual HTTPResult getStatusesHomeTimeline (void(*func)(char *buf, size_t siz)=NULL)=0
 Returns the 20 most recent statuses, including retweets if they exist, posted by the authenticating user and the user's they follow.
virtual HTTPResult postStatusesUpdate (const std::string datatext, void(*func)(char *buf, size_t siz)=NULL)=0
 Updates the authenticating user's status.

Static Protected Attributes

static const std::string URLBASE_V1 = "http://api.supertweet.net/1/"
 SuperTweet API interface driver.

Detailed Description

SuperTweet API interface driver.

(Version 0.0.1)

Copyright (C) 2010 Shinichiro Nakamura (CuBeatSystems) http://shinta.main.jp/ SuperTweet driver class.

Definition at line 14 of file SuperTweet.h.


Constructor & Destructor Documentation

SuperTweet ( const std::string  account,
const std::string  password 
)

Create.

Parameters:
accountAccount name.
passwordPassword.

Definition at line 18 of file SuperTweet.cpp.

~SuperTweet (  ) [virtual]

Dispose.

Definition at line 27 of file SuperTweet.cpp.


Member Function Documentation

virtual HTTPResult getStatusesHomeTimeline ( void(*)(char *buf, size_t siz)  func = NULL ) [pure virtual]

Returns the 20 most recent statuses, including retweets if they exist, posted by the authenticating user and the user's they follow.

Parameters:
funcA pointer to a callback function.
Returns:
Result code.

Implemented in SuperTweetV1XML.

virtual HTTPResult getStatusesUserTimeline ( void(*)(char *buf, size_t siz)  func = NULL ) [pure virtual]

Returns the 20 most recent statuses posted by the authenticating user.

Parameters:
funcA pointer to a callback function.
Returns:
Result code.

Implemented in SuperTweetV1XML.

virtual HTTPResult postStatusesUpdate ( const std::string  datatext,
void(*)(char *buf, size_t siz)  func = NULL 
) [pure virtual]

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.

Parameters:
funcA pointer to a callback function.
Returns:
Result code.

Implemented in SuperTweetV1XML.

void setTimeout ( int  ms )

Set timeout.

Parameters:
msTimeout. [ms]

Definition at line 35 of file SuperTweet.cpp.


Field Documentation

const std::string URLBASE_V1 = "http://api.supertweet.net/1/" [static, protected]

SuperTweet API interface driver.

(Version 0.0.1)

Copyright (C) 2010 Shinichiro Nakamura (CuBeatSystems) http://shinta.main.jp/

Definition at line 64 of file SuperTweet.h.