Station API

Dependents:   GMCStation

Embed: (wiki syntax)

« Back to documentation index

SuperTweetClient Class Reference

SuperTweetClient Class Reference

Client API for accessing SuperTweet gateway. More...

#include <SuperTweetClient.h>

Public Member Functions

 SuperTweetClient (char *user, char *password, char *messageTemplate, bool verbose=false)
 creates a SuperTweetClient object
bool tweet (char *format,...)
 tweets message

Static Public Member Functions

static SuperTweetClient create (char *filename, bool verbose=false)
 creates a SuperTweetCient object from a config file

Detailed Description

Client API for accessing SuperTweet gateway.

Definition at line 32 of file SuperTweetClient.h.


Constructor & Destructor Documentation

SuperTweetClient ( char *  user,
char *  password,
char *  messageTemplate,
bool  verbose = false 
)

creates a SuperTweetClient object

Parameters:
useruser account
passwordpassword (in plain text)
messageTemplatemessage template for the tweet message
verboseif true display debug info

Definition at line 42 of file SuperTweetClient.h.


Member Function Documentation

static SuperTweetClient create ( char *  filename,
bool  verbose = false 
) [static]

creates a SuperTweetCient object from a config file

Parameters:
filenamename of the configuration file
verboseif true display debug info

Definition at line 56 of file SuperTweetClient.h.

bool tweet ( char *  format,
  ... 
)

tweets message

Parameters:
formattemplate format string, if empty string specified, messageTemplate specified in the constructor is to be used
verboseif true display debug info

Definition at line 86 of file SuperTweetClient.h.