logo
logo

Interface IApiClient

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

Namespace: Stylelabs.M.Sdk.WebClient.Contracts
Assembly: Stylelabs.M.Sdk.WebClient.dll
Syntax
public interface IApiClient

Properties

DisableCompatibilityChecks

Gets or sets a value indicating whether disable compatibility. checks should be disabled. true means the check is not performed. This is value is shared over all instances.

Declaration
bool DisableCompatibilityChecks { get; set; }
Property Value
Type Description
System.Boolean

Methods

GetApiInfoAsync()

Gets the REST API information. The result will be cached.

Declaration
Task<IApiInfo> GetApiInfoAsync()
Returns
Type Description
Task<IApiInfo>

The API information.

GetApiRoutesAsync()

Gets the REST API routes. The result will be cached.

Declaration
Task<ApiRoutesDictionary> GetApiRoutesAsync()
Returns
Type Description
Task<ApiRoutesDictionary>

The REST API routes.

Refresh()

Forces a refresh of the cached REST API information.

Declaration
Task Refresh()
Returns
Type Description
Task

An awaitable .

Can we improve this article ? Provide feedback