BaseComponentContext class

クライアント側コンポーネントのコンテキスト オブジェクトの基底クラス。

注釈

"context" オブジェクトは、関連するコンポーネントと対話するビジネス ロジックで必要となる可能性がある、既知のサービスとその他のオブジェクトのコレクションです。 各コンポーネントの種類には、Web パーツの WebPartContext、クライアント側拡張機能の ExtensionContext など、BaseComponentContext の独自の特殊なサブクラスがあります。

このクラスのコンストラクターは、内部にマークされています。 サードパーティのコードは、コンストラクターを直接呼び出したり、BaseComponentContext クラスを展開するサブクラスを作成したりすることはできません。

プロパティ

aadHttpClientFactory

コンポーネントのこのインスタンス用に作成された AadHttpClientFactory のインスタンス

aadTokenProviderFactory

コンポーネントのこのインスタンス用に作成された AadTokenProviderFactory のインスタンス

dynamicDataProvider

コンポーネントに関連付けられている動的データ プロバイダーを返します。

dynamicDataSourceManager

コンポーネントに関連付けられている動的データ ソース マネージャーを返します。

httpClient

コンポーネントのこのインスタンス用に作成された HttpClient のインスタンス

instanceId

コンポーネントのインスタンスの一意識別子。

isDisposed

コンテキストが破棄された場合は true を返します。

isServedFromLocalhost

ソリューションが localhost から提供されている場合は true を返します

manifest

クライアント側コンポーネントのマニフェスト。

msGraphClientFactory

コンポーネントのこのインスタンス用に作成された MSGraphClientFactory のインスタンス

pageContext

ページ コンテキストは、クライアント側のアプリケーション、Web パーツ、およびその他のコンポーネント間で共有する必要のある、共通の SharePoint オブジェクトに対する標準の定義を提供します。

serviceScope

このコンポーネントに関連付けられている ServiceScope

spHttpClient

コンポーネントのこのインスタンス用に作成された SpHttpClient のインスタンス

メソッド

dispose()

基本コンポーネント コンテキストを破棄します。

プロパティの詳細

aadHttpClientFactory

コンポーネントのこのインスタンス用に作成された AadHttpClientFactory のインスタンス

get aadHttpClientFactory(): AadHttpClientFactory;

プロパティ値

aadTokenProviderFactory

コンポーネントのこのインスタンス用に作成された AadTokenProviderFactory のインスタンス

get aadTokenProviderFactory(): AadTokenProviderFactory;

プロパティ値

dynamicDataProvider

コンポーネントに関連付けられている動的データ プロバイダーを返します。

get dynamicDataProvider(): DynamicDataProvider;

プロパティ値

dynamicDataSourceManager

コンポーネントに関連付けられている動的データ ソース マネージャーを返します。

get dynamicDataSourceManager(): DynamicDataSourceManager;

プロパティ値

httpClient

コンポーネントのこのインスタンス用に作成された HttpClient のインスタンス

get httpClient(): HttpClient;

プロパティ値

instanceId

コンポーネントのインスタンスの一意識別子。

get instanceId(): string;

プロパティ値

string

注釈

コンポーネントの実装は、ページに複数回読み込むことができます。 たとえば、コンポーネントがグラフ化 Web パーツの場合、この Web パーツの複数のインスタンスを SharePoint キャンバスに追加できます。 instanceId は、これらの各インスタンスを一意に識別します。

isDisposed

コンテキストが破棄された場合は true を返します。

get isDisposed(): boolean;

プロパティ値

boolean

isServedFromLocalhost

ソリューションが localhost から提供されている場合は true を返します

get isServedFromLocalhost(): boolean;

プロパティ値

boolean

manifest

クライアント側コンポーネントのマニフェスト。

readonly manifest: IClientSideComponentManifest;

プロパティ値

msGraphClientFactory

コンポーネントのこのインスタンス用に作成された MSGraphClientFactory のインスタンス

get msGraphClientFactory(): MSGraphClientFactory;

プロパティ値

pageContext

ページ コンテキストは、クライアント側のアプリケーション、Web パーツ、およびその他のコンポーネント間で共有する必要のある、共通の SharePoint オブジェクトに対する標準の定義を提供します。

get pageContext(): PageContext;

プロパティ値

serviceScope

このコンポーネントに関連付けられている ServiceScope

get serviceScope(): ServiceScope;

プロパティ値

注釈

子サービス スコープは、クライアント側コンポーネントごとに作成されます。

spHttpClient

コンポーネントのこのインスタンス用に作成された SpHttpClient のインスタンス

get spHttpClient(): SPHttpClient;

プロパティ値

メソッドの詳細

dispose()

基本コンポーネント コンテキストを破棄します。

dispose(): void;

戻り値

void