VpnChannel.ActivateForeground(String, ValueSet) Méthode

Référence

Définition

Espace de noms:: Windows.Networking.Vpn

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Modifier

Active l’application VPN au premier plan. Cela est souvent utilisé pour permettre à l’utilisateur d’entrer des informations d’identification. Vous pouvez appeler ActivateForeground uniquement à partir de votre implémentation de IVpnPlugin.Connect. Pendant que l’application se trouve au premier plan, le délai d’expiration de connexion normal est suspendu.

L’appel ActivateForeground est annulé en cas de longue pause (environ 10 minutes). Si vous ne parvenez pas à lancer, le plug-in doit idéalement prendre en charge une méthode d’authentification qui n’a pas besoin d’interface utilisateur .

Destiné à prendre en charge les schémas d’authentification basés sur le web tels que SAML (Security Assertion Markup Language) et l’authentification Azure Active Directory (AAD).

public:
 virtual ValueSet ^ ActivateForeground(Platform::String ^ packageRelativeAppId, ValueSet ^ sharedContext) = ActivateForeground;

ValueSet ActivateForeground(winrt::hstring const& packageRelativeAppId, ValueSet const& sharedContext);

public ValueSet ActivateForeground(string packageRelativeAppId, ValueSet sharedContext);

function activateForeground(packageRelativeAppId, sharedContext)

Public Function ActivateForeground (packageRelativeAppId As String, sharedContext As ValueSet) As ValueSet

Paramètres

packageRelativeAppId: String
Platform::String

winrt::hstring

Chaîne contenant l’identificateur d’application relatif au package (PRAID) de l’application au premier plan à lancer.

sharedContext: ValueSet

Objet ValueSet utilisé pour transmettre des informations à l’application de premier plan. L’application de premier plan peut y accéder à partir des arguments d’événement d’activation.

Retours

ValueSet

Objet ValueSet contenant un objet Windows Runtime de votre choix qui est passé de l’application de premier plan au plug-in VPN, indiquant le résultat de la demande de premier plan.

Configuration requise pour Windows

Famille d’appareils	Windows 11 (introduit dans 10.0.22000.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v14.0)
Fonctionnalités de l’application	networkingVpnProvider

Remarques

Notes

L’appel de cette API en dehors de l’implémentation de la méthode IVpnPlugin.Connect dans un plug-in VPN échoue.

L’utilisation du mécanisme d’activation de premier plan nécessite de gérer l’activation à plusieurs endroits.

Dans votre méthode IVpnPlugin.Connect , vous allez appeler ActivateForeground avec l’identificateur d’application relatif au package (PRAID) correct et un ValueSet qui contient toutes les valeurs que vous souhaitez envoyer à votre application de premier plan.

Dans l’application de premier plan, vous devez intercepter l’activation. L’application de premier plan sera activée avec une valeur Windows.ApplicationModel.ActivationKind de VpnForeground. Les arguments d’activation seront de type Windows.Networking.Vpn.VpnForegroundActivatedEventArgs et incluront trois champs.

ProfileName (String).
SharedContext (ValueSet).
ActivationOperation (Windows.Networking.Vpn.VpnForegroundActivationOperation.

L’application de premier plan peut ensuite configurer l’interface utilisateur de votre application pour gérer l’autorisation nécessaire (ou les données nécessaires). Lorsque vous avez terminé, vous devez appeler la méthode Complete de l’ActivationOperation, en transmettant un ValueSet de valeurs que vous souhaitez retourner à l’appel IVpnPlugin.Connect .

De retour dans l’appel IVpnPlugin.Connect , utilisez le ValueSet retourné par ActivateForeground pour déterminer si l’authentification a réussi et gérer les erreurs éventuelles.

S’applique à

Partager via