Loic.loklak.loklak_dotnet_api 1.0.0

LoklakDotNet

This is the .NET API wrapper for the Loklak server (http://loklak.org).

##Installation To install LoklakDotNet, run the following command in the Package Manager Console.

Install-Package LoklakDotNet

You can also search for loklak in the Nuget Package Manager.

###Supported Platforms

1. .NET Framework 4.5
2. ASP.NET Core 5.0
3. Windows 8/8.1
4. Windows Universal (UWP)
5. Windows Phone 8.1
6. Windows Phone Silverlight 8.1
7. Xamarin.Android
8. Xamarin.iOS
9. Xamarin.iOS (Classic)

##How to use See the LoklakDotNetTests project for usage examples. async/await pattern is followed. All methods output the raw JSON string response. Parse the JSON using a JSON parser of your choice. Examples in LoklakDotNetTests use Newtonsoft.JSON. For documentation on the API, go here.

<a name='contents'></a>

Contents

• Loklak
  • #ctor(apiUrl)
  • geocode(places)
  • hello()
  • markdown(text,color_text,color_background,padding,uppercase)
  • peers()
  • search(q,count,source,fields,limit,timeZoneOffset)
  • status()
  • user(screen_name,follower_count,following_count)
• LoklakSearchTerm

<a name='T-LoklakDotNet-Loklak'></a>

Loklak

Namespace

LoklakDotNet

<a name='M-LoklakDotNet-Loklak-#ctor-System-String-'></a>

#ctor(apiUrl) constructor

Summary

Initializes the Loklak API wrapper

Parameters

Loklak loklak = new Loklak(); or Loklak loklak = new Loklak("http://myloklakapp/api/");

<a name='M-LoklakDotNet-Loklak-geocode-System-Collections-Generic-IList{System-String}-'></a>

geocode(places) method

Summary

This servlet provides geocoding of place names to location coordinates and also reverse geocoding of location coordinates to place names.

Returns

Parameters

var places = new List<string>();
places.Add("Delhi");
places.Add("Berlin");
var result = await loklak.geocode(places);

<a name='M-LoklakDotNet-Loklak-hello'></a>

hello() method

Summary

The hello servlet is part of the loklak peer-to-peer bootstrap process and shall be used to announce that a new client has been started up. The hello request is done automatically after a loklak startup against the loklak backend as configured in the settings in field backend. The back-end server then does not return any data, just an 'ok' string object.

Returns

{"status":"ok"}

Parameters

This method has no parameters.

var result = await loklak.hello();

<a name='M-LoklakDotNet-Loklak-markdown-System-String,System-String,System-String,System-Int32,System-Boolean-'></a>

markdown(text,color_text,color_background,padding,uppercase) method

Summary

This servlet provides an image with text on it.

Returns

Image object in string

Parameters

var result = await loklak.markdown("hello");

<a name='M-LoklakDotNet-Loklak-peers'></a>

peers() method

Summary

This servlet combined the result of the hello calls from all peers and provides a list of addresses where the remote peers can be accessed.

Returns

Parameters

This method has no parameters.

var result = await loklak.peers();

<a name='M-LoklakDotNet-Loklak-search-LoklakDotNet-LoklakSearchTerm,System-Int32,System-String,System-Collections-Generic-IList{System-String},System-Int32,System-Int32-'></a>

search(q,count,source,fields,limit,timeZoneOffset) method

Summary

Get a search result from the server

Returns

Parameters

var st = new LoklakSearchTerm(); //See LoklakSearchTerm properties for more options
st.terms = "loklak";
var result = await loklak.search(st);

<a name='M-LoklakDotNet-Loklak-status'></a>

status() method

Summary

The status servlet shows the size of the internal Elasticsearch search index for messages and users. Furthermore, the servlet reflects the current browser clients settings in the client_info.

Returns

Parameters

This method has no parameters.

var result = await loklak.status();

<a name='M-LoklakDotNet-Loklak-user-System-String,System-Int32,System-Int32-'></a>

user(screen_name,follower_count,following_count) method

Summary

This servlet provides the retrieval of user followers and the accounts which the user is following.

Returns

Parameters

var result = await loklak.user("loklak_app", <max-follower-count>, <max-following-count>);

<a name='T-LoklakDotNet-LoklakSearchTerm'></a>

LoklakSearchTerm

Namespace

LoklakDotNet

Summary

Constructs a search term for the Loklak.search() method

##Contact Contact @aneeshd16 on Twitter or at me@aneesh.xyz