1. IWebMClient

Interface IWebMClient

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

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

Namespace: Stylelabs.M.Sdk.WebClient
Assembly: Stylelabs.M.Sdk.WebClient.dll
Syntax
public interface IWebMClient : IMClient

Properties

Api

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

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

Declaration
string ImpersonatedUsername { get; }
Property Value
TypeDescription
System.String

LinkHelper

Contains functionality to build and parse links.

Declaration
ILinkHelper LinkHelper { get; }
Property Value
TypeDescription
ILinkHelper

Package

Contains functionality to import and export packages.

Declaration
IPackageClient Package { get; }
Property Value
TypeDescription
IPackageClient

Raw

Contains functionality to do custom HTTP requests.

Declaration
IRawClient Raw { get; }
Property Value
TypeDescription
IRawClient

Uploads

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 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
IDelegatingHandlerFactoryfactory

SetHttpClientFactory(IHttpClientFactory)

Sets a factory that will be used to create a 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
IHttpClientFactoryfactory

SetKnownSSoRedirects(IEnumerable<Uri>)

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

Declaration
void SetKnownSSoRedirects(IEnumerable<Uri> ssoRedirects)
Parameters
TypeNameDescription
IEnumerable<Uri>ssoRedirects

SSO 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
Task

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>
この記事を改善するための提案がある場合は、 お知らせください!