IronSight.Client 0.0.6-beta

IronSight.Client

The official IronSight .NET library, targeting .NET Standard 2.1+.

Installation

Using the .NET Core command-line interface (CLI) tools:

dotnet add package IronSight.Client

Using the NuGet Command Line Interface (CLI):

nuget install IronSight.Client

Using the Package Manager Console:

Install-Package IronSight.Client

From within Visual Studio:

1. Open the Solution Explorer.
2. Right-click on a project within your solution.
3. Click on Manage NuGet Packages...
4. Click on the Browse tab and search for "IronSight.Client".
5. Click on the IronSight.Client package, select the appropriate version in the right-tab and click Install.

Documentation

For complete API docs check out the documentation portal.

Usage

Authentication

IronSight authenticates API requests with a bearer token, which can be acquired by .... TODO: Add steps

Use the IronSightClient constructor to set your bearer token.

var client = new IronSightClient(yourBearerToken);

Using the API

All resource types can be accessed through the IronSightClient class.

var myHubId = "my-hub";
Hub hubs = client.Hubs.Get(myHubId);
IEnumerable<Division> divisions = client.Divisions.GetAll(myHubId);

Retrieving a resource

Individual resources can be retrieved by ID using the Get or GetAsync methods.

var myHubId = "my-hub";
Hub hubs = client.Hubs.Get(myHubId);

Listing a resource

Listing resources can be done using the GetAll or GetAllAsync methods.

Some resource types will return all resources with a single call, as an IEnumerable.

IEnumerable<Hub> = client.Hubs.GetAll();

Others may return one page of resources at a time:

PaginatedList<Location> locationsPageOne = client.Locations.GetAll();

foreach (Location location in locationsPageOne) {
    Console.WriteLine($"Location {location.Name}");
}

PaginatedList<Location> locationsPageTwo = client.Locations.NextPage(locationsPageOne);

Using a custom HttpClient

You can configure the library with your own custom HttpClient:

var client = new IronSightClient(yourHttpClient);

Note If you provide a custom HttpClient it is responsible for sending a bearer token for authorization.

Automatic retries

The library automatically retries requests on intermittent failures like on a connection error, timeout, etc.

Support

TODO: What do we tell people about getting help with the SDK?