Interface IApiClient

Current version: 4.0

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

Namespace: StylelabsStylelabs.MSdkWebClientContracts
Assembly: Stylelabs.M.Sdk.WebClient.dll
Syntax
RequestResponse
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
RequestResponse
bool DisableCompatibilityChecks { get; set; }
Property Value
TypeDescription
bool

Methods

GetApiInfoAsync()

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

Declaration
RequestResponse
Task<IApiInfo> GetApiInfoAsync()
Returns
TypeDescription
Task<>IApiInfo

The API information.

GetApiRoutesAsync()

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

Declaration
RequestResponse
Task<ApiRoutesDictionary> GetApiRoutesAsync()
Returns
TypeDescription
Task<>ApiRoutesDictionary

The REST API routes.

Refresh()

Forces a refresh of the cached REST API information.

Declaration
RequestResponse
Task Refresh()
Returns
TypeDescription
Task

An awaitable .

Do you have some feedback for us?

If you have suggestions for improving this article,