Logo Search packages:      
Sourcecode: tasque version File versions  Download package

RtmNet::Rtm Class Reference

List of all members.


Detailed Description

The main Rtm class.

Create an instance of this class and then call its methods to perform methods on Rtm.

RtmNet.Rtm Rtm = new RtmNet.Rtm();
          User user = Rtm.PeopleFindByEmail("cal@iamcal.com");
          Console.WriteLine("User Id is " + u.UserId);

Definition at line 25 of file Rtm.cs.


Public Member Functions

string AuthCalcUrl (string frob, AuthLevel authLevel)
 Calculates the URL to redirect the user to Rtm web site for authentication. Used by desktop application. See AuthGetFrob for example code.
string AuthCalcWebUrl (AuthLevel authLevel)
 Calculates the URL to redirect the user to Rtm web site for auehtntication. Used by Web applications. See AuthGetFrob for example code.
Auth AuthCheckToken (string token)
 Checks a authentication token with the Rtm service to make sure it is still valid.
string AuthGetFrob ()
 Retrieve a temporary FROB from the Rtm service, to be used in redirecting the user to the Rtm web site for authentication. Only required for desktop authentication.
Auth AuthGetFullToken (string miniToken)
 Gets the full token details for a given mini token, entered by the user following a web based authentication.
Auth AuthGetToken (string frob)
 After the user has authenticated your application on the Rtm web site call this method with the FROB (either stored from AuthGetFrob or returned in the URL from the Rtm web site) to get the users token.
Contacts ContactsGetList ()
 Gets a list of contacts for the logged in user. Requires authentication.
Contacts ContactsGetPublicList (string userId)
 Gets a list of the given users contact, or those that are publically avaiable.
Lists ListsGetList ()
 Gets a list of contacts for the logged in user. Requires authentication.
Note NotesAdd (string timeline, string listID, string taskSeriesID, string taskID, string noteTitle, string noteText)
 Adds a note to a task.
void NotesDelete (string timeline, string noteID)
 Deletes a note.
Note NotesEdit (string timeline, string noteID, string noteTitle, string noteText)
 Modifies an existing note.
 Rtm (string apiKey, string sharedSecret, string token)
 Create a new instance of the Rtm class with the email address and password given.
 Rtm (string apiKey, string sharedSecret)
 Creates a new instance of the Rtm class with an API key and a Shared Secret. This is only useful really useful for calling the Auth functions as all other authenticationed methods also require the API Token.
 Rtm (string apiKey)
 Create a new instance of the Rtm class with no authentication.
 Rtm ()
 Constructor loads configuration settings from app.config or web.config file if they exist.
List TasksAdd (string timeline, string name, string listID)
List TasksAdd (string timeline, string name)
void TasksAddTags (string photoId, string tags)
 Add a selection of tags to a photo.
void TasksAddTags (string photoId, string[] tags)
 Add a selection of tags to a photo.
List TasksComplete (string timeline, string listID, string taskSeriesID, string taskID)
 Marks a task complete.
List TasksDelete (string timeline, string listID, string taskSeriesID, string taskID)
Tasks TasksGetList (string listID)
 Gets a list of contacts for the logged in user. Requires authentication.
List TasksMoveTo (string timeline, string fromListID, string toListID, string taskSeriesID, string taskID)
 Moves a task from one list to another.
List TasksSetDueDate (string timeline, string listID, string taskSeriesID, string taskID, string due)
 Sets the due date of a task.
List TasksSetDueDate (string timeline, string listID, string taskSeriesID, string taskID)
 Sets the due date of a task.
List TasksSetDueDateParse (string timeline, string listID, string taskSeriesID, string taskID, string due)
 Sets the due date of a task.
List TasksSetName (string timeline, string listID, string taskSeriesID, string taskID, string name)
 Sets the priority on a task.
List TasksSetPriority (string timeline, string listID, string taskSeriesID, string taskID, string priority)
 Sets the priority on a task.
List TasksUncomplete (string timeline, string listID, string taskSeriesID, string taskID)
 Marks a task as uncomplete.
XmlElement[] TestEcho (string echoParameter, string echoValue)
 Runs the Rtm.test.echo method and returned an array of XmlElement items.
XmlElement[] TestGeneric (string method, NameValueCollection parameters)
 Can be used to call unsupported methods in the Rtm API.
FoundUser TestLogin ()
 Test the logged in state of the current Filckr object.
string TimelineCreate ()

Properties

string ApiKey [get, set]
 Get or set the API Key to be used by all calls. API key is mandatory for all calls to Rtm.
string ApiSecret [get, set]
 API shared secret is required for all calls that require signing, which includes all methods that require authentication, as well as the actual Rtm.auth.* calls.
string ApiToken [get, set]
 The API token is required for all calls that require authentication. A RtmException will be raised by Rtm if the API token is not set when required.
string AuthToken [get, set]
 The authentication token is required for all calls that require authentication. A RtmException will be raised by Rtm if the authentication token is not set when required.
SupportedService CurrentService [get]
 The current service that the Rtm API is using.
static SupportedService DefaultService [get]
 The default service to use for new Rtm instances.
int HttpTimeout [get, set]
 Internal timeout for all web requests in milliseconds. Defaults to 30 seconds.
bool IsAuthenticated [get]
 Checks to see if a shared secret and an api token are stored in the object. Does not check if these values are valid values.
string LastRequest [get]
 Returns the last URL requested. Includes API signing.
string LastResponse [get]
 Returns the raw XML returned from the last response. Only set it the response was not returned from cache.
WebProxy Proxy [get, set]
 You can set the WebProxy or alter its properties. It defaults to your internet explorer proxy settings.

Private Member Functions

void CheckApiKey ()
string DoGetResponse (string url, string variables)
 A private method which performs the actual HTTP web request if the details are not found within the cache.
Response GetResponse (Hashtable parameters)

Static Private Member Functions

static string Md5Hash (string unhashed)

Private Attributes

string apiKey
string apiToken
const string AuthUrl = "http://api.rememberthemilk.com/services/auth/"
const string BaseUrl = "http://api.rememberthemilk.com/services/rest"
string lastRequest
string lastResponse
WebProxy proxy
string sharedSecret
int timeout = 30000
const string UserAgent = "Mozilla/4.0 RtmNet API (compatible; MSIE 6.0; Windows NT 5.1)"

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index