BaseComponentContext class
Базовый класс для объектов контекста для клиентских компонентов.
Комментарии
Объект context — это коллекция хорошо известных служб и других объектов, которые, скорее всего, потребуются бизнес-логике, взаимодействующей со связанным компонентом. Каждый тип компонента имеет собственный специализированный подкласс BaseComponentContext, например WebPartContext для веб-частей, ExtensionContext для расширений на стороне клиента и т. д.
Конструктор для этого класса помечен как внутренний. Сторонний код не должен напрямую вызывать конструктор или создавать подклассы, расширяющие класс BaseComponentContext
.
Свойства
aad |
Экземпляр AadHttpClientFactory, созданный для этого экземпляра компонента |
aad |
Экземпляр AadTokenProviderFactory, созданный для этого экземпляра компонента |
dynamic |
Возвращает динамический поставщик данных, связанный с компонентом. |
dynamic |
Возвращает диспетчер динамических источников данных, связанный с компонентом . |
http |
Экземпляр HttpClient, созданный для этого экземпляра компонента |
instance |
Уникальный идентификатор экземпляра компонента. |
is |
Возвращает значение true, если контекст удален. |
is |
Возвращает значение true, если решение обслуживается из localhost. |
manifest | Манифест для клиентского компонента. |
ms |
Экземпляр MSGraphClientFactory, созданный для этого экземпляра компонента |
page |
Контекст страницы предоставляет стандартные определения для общих объектов SharePoint, к которым нужно предоставить общий доступ для клиентского приложения, веб-частей и других компонентов. |
service |
Связанный объект ServiceScope для этого компонента. |
sp |
Экземпляр 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
Комментарии
Реализацию компонента можно загрузить на страницу несколько раз. Например, если компонент является веб-частью диаграммы, на холст SharePoint можно добавить несколько экземпляров этой веб-части. InstanceId однозначно идентифицирует каждый из этих экземпляров.
isDisposed
Возвращает значение true, если контекст удален.
get isDisposed(): boolean;
Значение свойства
boolean
isServedFromLocalhost
Возвращает значение true, если решение обслуживается из localhost.
get isServedFromLocalhost(): boolean;
Значение свойства
boolean
manifest
Манифест для клиентского компонента.
readonly manifest: IClientSideComponentManifest;
Значение свойства
msGraphClientFactory
Экземпляр MSGraphClientFactory, созданный для этого экземпляра компонента
get msGraphClientFactory(): MSGraphClientFactory;
Значение свойства
pageContext
Контекст страницы предоставляет стандартные определения для общих объектов SharePoint, к которым нужно предоставить общий доступ для клиентского приложения, веб-частей и других компонентов.
get pageContext(): PageContext;
Значение свойства
serviceScope
Связанный объект ServiceScope для этого компонента.
get serviceScope(): ServiceScope;
Значение свойства
Комментарии
Для каждого клиентского компонента создается область дочерней службы.
spHttpClient
Экземпляр SpHttpClient, созданный для этого экземпляра компонента
get spHttpClient(): SPHttpClient;
Значение свойства
Сведения о методе
dispose()
Удаляет контекст базового компонента.
dispose(): void;
Возвращаемое значение
void