VpnChannel.ActivateForeground(String, ValueSet) Método

Definição

Namespace:

Windows.Networking.Vpn

Ativa o aplicativo VPN em primeiro plano. Isso geralmente é usado para permitir que o usuário insira credenciais. Você pode chamar ActivateForeground somente na implementação de IVpnPlugin.Connect. Enquanto o aplicativo está em primeiro plano, o tempo limite regular do Connect é pausado.

A chamada ActivateForeground será cancelada se houver uma pausa longa (cerca de 10 minutos). Se não for possível iniciar, o plug-in deverá dar suporte a um método de autenticação que não precise de interface do usuário (interface do usuário).

Destinado a dar suporte a esquemas de autenticação baseados na Web, como a SAML (Security Assertion Markup Language) e a autenticação do AAD (Azure Active Directory).

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

Parâmetros

packageRelativeAppId

String

Platform::String

winrt::hstring

Uma cadeia de caracteres que contém o PRAID (identificador de aplicativo relativo ao pacote) do aplicativo em primeiro plano a ser iniciado.

sharedContext

ValueSet

Um objeto ValueSet usado para passar informações para o aplicativo em primeiro plano. O aplicativo em primeiro plano pode acessá-los nos argumentos de evento de ativação.

Retornos

ValueSet

Um objeto ValueSet que contém um objeto do Windows Runtime de sua escolha que é passado de volta do aplicativo em primeiro plano para o plug-in VPN, indicando o resultado da solicitação em primeiro plano.

Requisitos do Windows

Família de dispositivos	Windows 11 (introduzida na 10.0.22000.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v14.0)
Funcionalidades do aplicativo	networkingVpnProvider

Comentários

Nota

A chamada dessa API fora da implementação do método IVpnPlugin.Connect em um plug-in VPN falhará.

O uso do mecanismo de ativação em primeiro plano requer o tratamento da ativação em vários locais.

Em seu método IVpnPlugin.Connect, você chamará ActivateForeground com o PRAID (identificador de aplicativo relativo ao pacote) correto e um ValueSet que contém todos os valores que você deseja enviar para seu aplicativo em primeiro plano.

No aplicativo em primeiro plano, você precisa capturar a ativação. O aplicativo em primeiro plano será ativado com um valor Windows.ApplicationModel.ActivationKind de VpnForeground. Os argumentos de ativação serão do tipo Windows.Networking.Vpn.VpnForegroundActivatedEventArgse incluirão três campos.

1. ProfileName (de cadeia de caracteres de).
2. SharedContext (ValueSet).
3. ActivationOperation (Windows.Networking.Vpn.VpnForegroundActivationOperation.

Em seguida, o aplicativo em primeiro plano pode configurar a interface do usuário (interface do usuário) do aplicativo para lidar com a autorização necessária (ou quaisquer dados necessários). Quando terminar, você deve chamar o método Complete doActivationOperation , passando uma ValueSet de valores que você deseja retornar para a chamada IVpnPlugin.Connect.

De volta à chamada IVpnPlugin.Connect, use o ValueSet retornado de ActivateForeground para decidir se a autenticação foi bem-sucedida e lidar com erros.