Elarian 0.0.4

.NET Standard 2.0
Install-Package Elarian -Version 0.0.4
dotnet add package Elarian --version 0.0.4
<PackageReference Include="Elarian" Version="0.0.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Elarian --version 0.0.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Elarian, 0.0.4"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Elarian as a Cake Addin
#addin nuget:?package=Elarian&version=0.0.4

// Install Elarian as a Cake Tool
#tool nuget:?package=Elarian&version=0.0.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Elarian

The SDK provides convenient access to the Elarian APIs from .NET applications.

Project Status: Still under ACTIVE DEVELOPMENT, APIs are unstable and may change at any time until release of v1.0.0.

Install

You can install the package from nuget by running:

dotnet add package elarian

Usage

General operations

Once you register your app, you can establish connection by creating a new instance of ElarianClient and passing connection information:

var client = new ElarianClient(new ElarianAppCredentials
{
    ApiKey = "el_api_key_62...",
    AppId = "test-app",
    OrgId = "og-S..."
});

await client.ConnectAsync();

Once you establish connection, you can call methods on the client instance:

var tag = await client.SendMessageByTag(
  new MessagingChannelNumber { Channel = MessagingChannel.Sms, Number = "254711234567" },
    new OutboundMessage
    {
    Body = new OutboundMessageBody
    {
      Text = "test"
    }
  }, new IndexMapping() { Key = "1", Value = "2" });

You can also subscribe to events sent by the server:

var subscribe = client.ReceivedMessageNotification.Subscribe(notification =>
 {
     Console.WriteLine(notification.Text);
 });

//Dispose subscription when no longer needed
subscribe.Dispose();

Customer specific operations

To execute customer specific operations, you can use Customer class:

var customer = new Customer(client, new CustomerNumber("+254711234567", CustomerNumber.Provider.Cellular));

var appData = await customer.LeaseAppDataAsync();

Documentation

Full documentation of Elarian Api is available at https://developers.elarian.com/

Issues

If you find a bug, please file an issue on our issue tracker on GitHub.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.4 156 6/24/2021