BaseComponentContext class
Classe de base pour les objets de contexte pour les composants côté client.
Remarques
Un objet « contexte » est une collection de services connus et d’autres objets susceptibles d’être nécessaires par la logique métier qui interagit avec un composant associé. Chaque type de composant a sa propre sous-classe spécialisée de BaseComponentContext, par exemple WebPartContext pour les composants WebPart, ExtensionContext pour les extensions côté client, etc.
Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ou créer des sous-classes qui étendent la BaseComponentContext classe.
Propriétés
| aad |
La instance d’AadHttpClientFactory créée pour cette instance de composant |
| aad |
Instance d’AadTokenProviderFactory créé pour cette instance de composant |
| dynamic |
Retourne le fournisseur de données dynamiques associé au composant. |
| dynamic |
Retourne le gestionnaire de source de données dynamique associé au composant. |
| http |
Instance de HttpClient créée pour cette instance de composant |
| instance |
Identificateur unique pour la instance du composant. |
| is |
Retourne true si le contexte est supprimé. |
| is |
Retourne true si la solution est servie à partir de localhost |
| manifest | Manifeste pour le composant côté client. |
| ms |
Instance de MSGraphClientFactory créé pour cette instance de composant |
| page |
Le contexte de la page fournit des définitions standard pour les objets SharePoint communs qui doivent être partagés entre l’application cliente, les composants WebPart et d’autres composants. |
| service |
ServiceScope associé pour ce composant. |
| sp |
Instance de SpHttpClient créée pour cette instance de composant |
Méthodes
| dispose() | Supprime le contexte du composant de base. |
Détails de la propriété
aadHttpClientFactory
La instance d’AadHttpClientFactory créée pour cette instance de composant
get aadHttpClientFactory(): AadHttpClientFactory;Valeur de propriété
aadTokenProviderFactory
Instance d’AadTokenProviderFactory créé pour cette instance de composant
get aadTokenProviderFactory(): AadTokenProviderFactory;Valeur de propriété
dynamicDataProvider
Retourne le fournisseur de données dynamiques associé au composant.
get dynamicDataProvider(): DynamicDataProvider;Valeur de propriété
dynamicDataSourceManager
Retourne le gestionnaire de source de données dynamique associé au composant.
get dynamicDataSourceManager(): DynamicDataSourceManager;Valeur de propriété
httpClient
Instance de HttpClient créée pour cette instance de composant
get httpClient(): HttpClient;Valeur de propriété
instanceId
Identificateur unique pour la instance du composant.
get instanceId(): string;Valeur de propriété
string
Remarques
Une implémentation de composant peut être chargée plusieurs fois sur la page. Par exemple, si le composant est un composant WebPart de graphique, plusieurs instances de ce composant WebPart peuvent être ajoutées au canevas SharePoint. L’instanceId identifie de manière unique chacune de ces instances.
isDisposed
Retourne true si le contexte est supprimé.
get isDisposed(): boolean;Valeur de propriété
boolean
isServedFromLocalhost
Retourne true si la solution est servie à partir de localhost
get isServedFromLocalhost(): boolean;Valeur de propriété
boolean
manifest
Manifeste pour le composant côté client.
readonly manifest: IClientSideComponentManifest;Valeur de propriété
msGraphClientFactory
Instance de MSGraphClientFactory créé pour cette instance de composant
get msGraphClientFactory(): MSGraphClientFactory;Valeur de propriété
pageContext
Le contexte de la page fournit des définitions standard pour les objets SharePoint communs qui doivent être partagés entre l’application cliente, les composants WebPart et d’autres composants.
get pageContext(): PageContext;Valeur de propriété
serviceScope
ServiceScope associé pour ce composant.
get serviceScope(): ServiceScope;Valeur de propriété
Remarques
Une étendue de service enfant est créée pour chaque composant côté client.
spHttpClient
Instance de SpHttpClient créée pour cette instance de composant
get spHttpClient(): SPHttpClient;Valeur de propriété
Détails de la méthode
dispose()
Supprime le contexte du composant de base.
dispose(): void;Retours
void