VpnChannel.ActivateForeground(String, ValueSet) Metodo

Definizione

Attiva l'app VPN in primo piano. Viene spesso usato per consentire all'utente di immettere le credenziali. È possibile chiamare ActivateForeground solo dall'implementazione di IVpnPlugin.Connect. Mentre l'app è in primo piano, viene sospeso il normale timeout Connect.

La chiamata ActivateForeground verrà annullata se è presente una pausa lunga (circa 10 minuti). Se non è possibile avviare, il plug-in dovrebbe idealmente supportare un metodo di autenticazione che non richiede l'interfaccia utente.

Progettato per supportare schemi di autenticazione basati sul Web, ad esempio SAML (Security Assertion Markup Language) e l'autenticazione di 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

Parametri

packageRelativeAppId
String

Platform::String

winrt::hstring

Stringa contenente l'identificatore dell'applicazione relativo al pacchetto (PRAID) dell'app in primo piano da avviare.

sharedContext
ValueSet

Oggetto ValueSet utilizzato per passare informazioni all'app in primo piano. L'app in primo piano può accedervi dagli argomenti dell'evento di attivazione.

Restituisce

Oggetto ValueSet contenente un oggetto Windows Runtime di propria scelta passato dall'app in primo piano al plug-in VPN, che indica il risultato della richiesta in primo piano.

Requisiti Windows

Famiglia di dispositivi
Windows 11 (è stato introdotto in 10.0.22000.0)
API contract
Windows.Foundation.UniversalApiContract (è stato introdotto in v14.0)
Funzionalità dell'app
networkingVpnProvider

Commenti

Nota

La chiamata a questa API all 'esterno dell'implementazione del metodo IVpnPlugin.Connect in un plug-in VPN avrà esito negativo.

L'uso del meccanismo di attivazione in primo piano richiede la gestione dell'attivazione in diverse posizioni.

Nel metodo IVpnPlugin.Connect chiamerai ActivateForeground con l'identificatore di applicazione relativo al pacchetto corretto (PRAID) e un ValueSet che contiene tutti i valori da inviare all'app in primo piano.

Nell'app in primo piano è necessario intercettare l'attivazione. L'app in primo piano verrà attivata con un valore Windows.ApplicationModel.ActivationKind di VpnForeground. Gli argomenti di attivazione saranno di tipo Windows.Networking.Vpn.VpnForegroundActivatedEventArgse includeranno tre campi.

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

L'app in primo piano può quindi configurare l'interfaccia utente (UI) dell'app per gestire l'autorizzazione necessaria (o i dati necessari). Al termine, è necessario chiamare il metodo Complete delActivationOperation , passando un ValueSet di valori da restituire alla chiamata IVpnPlugin.Connect.

Tornare alla chiamata IVpnPlugin.Connect , usare il ValueSet restituito da ActivateForeground per decidere se l'autenticazione è riuscita e gestire eventuali errori.

Si applica a