BaseComponentContext class

客户端组件的上下文对象的基类。

注解

“context”对象是与关联组件交互的业务逻辑可能需要的已知服务和其他对象的集合。 每个组件类型都有自己的 BaseComponentContext 的专用子类,例如 Web 部件的 WebPartContext、客户端扩展的 ExtensionContext 等。

此类的构造函数标记为内部。 第三方代码不应直接调用构造函数或创建扩展类的 BaseComponentContext 子类。

属性

aadHttpClientFactory

为此组件实例创建的 AadHttpClientFactory 实例

aadTokenProviderFactory

为此组件实例创建的 AadTokenProviderFactory 实例

dynamicDataProvider

返回与组件关联的动态数据提供程序。

dynamicDataSourceManager

返回与组件关联的动态数据源管理器。

httpClient

为此组件的实例创建的 HttpClient 实例

instanceId

组件实例的唯一标识符。

isDisposed

如果释放上下文,则返回 true。

isServedFromLocalhost

如果从 localhost 提供解决方案,则返回 true

manifest

客户端组件的清单。

msGraphClientFactory

为此组件实例创建的 MSGraphClientFactory 实例

pageContext

页面上下文为公共 SharePoint 对象提供了标准的定义,该对象需要在客户端应用程序、Web 部件和其他组件之间共享。

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

页面上下文为公共 SharePoint 对象提供了标准的定义,该对象需要在客户端应用程序、Web 部件和其他组件之间共享。

get pageContext(): PageContext;

属性值

serviceScope

此组件的关联 ServiceScope

get serviceScope(): ServiceScope;

属性值

注解

为每个客户端组件创建一个子服务范围。

spHttpClient

为此组件的实例创建的 SpHttpClient 实例

get spHttpClient(): SPHttpClient;

属性值

方法详细信息

dispose()

释放基本组件上下文。

dispose(): void;

返回

void