1. Stylelabs.M.Sdk.WebClient

Interface IWebMClient

Provides additional features to the default SDK, specifically for HTTP and REST.

Namespace: StylelabsStylelabs.MSdkWebClient

Assembly: Stylelabs.M.Sdk.WebClient.dll

Syntax

public interface IWebMClient : IMClient

Properties

Api

Gets contains functionality to get REST API information. It will also check for compatibility with the server REST API.

Declaration

IApiClient Api { get; }

Property Value

TypeDescription
IApiClient

ImpersonatedUsername

Gets the name of the user being impersonated. This is null when impersonation is not active.

Declaration

string ImpersonatedUsername { get; }

Property Value

TypeDescription
string

LinkHelper

Gets contains functionality to build and parse links.

Declaration

ILinkHelper LinkHelper { get; }

Property Value

TypeDescription
ILinkHelper

Package

Gets contains functionality to import and export packages.

Declaration

IPackageClient Package { get; }

Property Value

TypeDescription
IPackageClient

Raw

Gets contains functionality to do custom HTTP requests.

Declaration

IRawClient Raw { get; }

Property Value

TypeDescription
IRawClient

Uploads

Gets contains functionality for file uploads.

Declaration

IUploadClient Uploads { get; }

Property Value

TypeDescription
IUploadClient

Methods

SetDelegatingHandlerFactory(IDelegatingHandlerFactory)

Sets a factory that will be used to create a System.Net.Http.DelegatingHandler on the first request per specific protocol and host. The handler will be reused for the next requests.

Declaration

void SetDelegatingHandlerFactory(IDelegatingHandlerFactory factory)

Parameters

TypeNameDescription
IDelegatingHandlerFactoryfactoryThe http client factory.

SetHttpClientFactory(IHttpClientFactory)

Sets a factory that will be used to create a System.Net.Http.HttpClient on the first request per specific protocol and host. The client will be reused for the next requests.

Declaration

void SetHttpClientFactory(IHttpClientFactory factory)

Parameters

TypeNameDescription
IHttpClientFactoryfactoryThe http client factory.

SetKnownSSoRedirects(IEnumerable)

Set known SSO redirect URls that must trigger security token refreshes.

Declaration

void SetKnownSSoRedirects(IEnumerable<Uri> ssoRedirects)

Parameters

TypeNameDescription
IEnumerable<>UrissoRedirectsSSO URls.

TestConnectionAsync()

Tests the following things:

  • if the client can successfully connect to the server
  • if the SDK and server are compatible
  • if the credentials are correct This will throw exceptions if it failed to connect. The exception type depends on what failed.

Declaration

Task TestConnectionAsync()

Returns

TypeDescription
TaskA representing the asynchronous operation.

Events

RefreshTokenReceived

Triggered when a new refresh-token has been received.

Declaration

event EventHandler<RefreshTokenReceivedEventArgs> RefreshTokenReceived

Event Type

TypeDescription
EventHandler<>RefreshTokenReceivedEventArgs

RequestCreated

Triggered when a web-request has been created.

Declaration

event EventHandler<RequestCreatedEventArgs> RequestCreated

Event Type

TypeDescription
EventHandler<>RequestCreatedEventArgs
If you have suggestions for improving this article, let us know!