gitter-badger / linqtotwitter Goto Github PK

LINQ to Twitter is an open source 3rd party LINQ Provider for the Twitter micro-blogging service. It uses standard LINQ syntax for queries and includes method calls for changes via the Twitter API.

Example

The following query returns search results where people are tweeting about LINQ to Twitter:

            var twitterCtx = new TwitterContext(...);

            var searchResponse =
                await
                (from search in twitterCtx.Search
                 where search.Type == SearchType.Search &&
                       search.Query == "\"LINQ to Twitter\""
                 select search)
                .SingleOrDefaultAsync();

            if (searchResponse != null && searchResponse.Statuses != null)
                searchResponse.Statuses.ForEach(tweet =>
                    Console.WriteLine(
                        "User: {0}, Tweet: {1}", 
                        tweet.User.ScreenNameResponse,
                        tweet.Text));

From a coding experience perspective, the TwitterContext type is analogous to DataContext (LINQ to SQL) or ObjectContext (LINQ to Entities). You use the TwitterContext instance, twitterCtx, to access IQueryable tweet categories. In the example above, the Search will give you the ability to search Twitter for tweets meeting some criteria.

Note: The ellipses in the TwitterContext parameters indicates that you need to provide an authorizer with credentials, which is required. You can visit Securing Your Applications for documentation on authorizers and visit the Download page for working examples.

Each query category has a Type property for the type of tweets you want to get back. For example, Status tweets can be made for Home, Mentions, or User timelines. Each query category also has an XxxType enum to help you figure out what is available. The example above uses SearchType.Search to perform searches. Another example would be Status queries which might have StatusType.Home as its Type. In the case of Search queries, Search is the only option, but the Type idiom is consistent accross all query categories.

Just like other LINQ providers, you get an IQueryable back from the query. You can see how to materialize the query by invoking the Single operator. For Search results, you receive one Search entity that contains information about the Search query and the Search entity contains a Results property that is a collection of SearchResult entities. On other queries, you would materialize the query with ToList for multiple results. Just like other LINQ providers, LINQ to Twitter does deferred execution, so operators such as ToList and Single or statements such as for and foreach loops will cause the query to execute and make the actual call to Twitter.

The latest version of LINQ to Twitter supports async. You can see this where the code above await's the query, using the SingleOrDefaultAsync() operator. Commands are async also. e.g. TweetAsync().

For more details on how LINQ to Twitter works, you can either click on the Documentation menu (above) or visit [Making API Calls] for API specific examples. The downloadable source code also contains copious examples in the projects with the Linq2Twitter_ prefix.

NuGet

In addition to being able to download from this site, you can also automatically install LINQ to Twitter into your Visual Studio projects via NuGet;

For help in getting started with NuGet: A Gentle Introduction to NuGet.

Available Feature Set

See Making API Calls.

For the latest news, follow @JoeMayo on Twitter.