VpnChannel.ActivateForeground(String, ValueSet) Método

Definición

Espacio de nombres:

Windows.Networking.Vpn

Activa la aplicación VPN en primer plano. Esto se usa a menudo para permitir que el usuario escriba las credenciales. Solo puede llamar a ActivateForeground desde la implementación de IVpnPlugin.Connect. Mientras la aplicación está en primer plano, se pausa el tiempo de espera de conexión normal.

La llamada a ActivateForeground se cancelará si hay una pausa larga (aproximadamente 10 minutos). Si no se puede iniciar, el complemento debería admitir idealmente un método de autenticación que no necesite interfaz de usuario (UI).

Diseñado para admitir esquemas de autenticación basados en web, como el lenguaje de marcado de aserción de seguridad (SAML) y la autenticación de 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

Parámetros

packageRelativeAppId

String

Platform::String

winrt::hstring

Cadena que contiene el identificador de aplicación relativo al paquete (PRAID) de la aplicación en primer plano que se va a iniciar.

sharedContext

ValueSet

Objeto ValueSet usado para pasar información a la aplicación en primer plano. La aplicación en primer plano puede acceder a ellas desde los argumentos del evento de activación.

Devoluciones

ValueSet

Objeto ValueSet que contiene un objeto Windows Runtime de su elección que se pasa de la aplicación en primer plano al complemento VPN, lo que indica el resultado de la solicitud en primer plano.

Requisitos de Windows

Familia de dispositivos	Windows 11 (se introdujo en la versión 10.0.22000.0)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v14.0)
Características de aplicaciones	networkingVpnProvider

Comentarios

Nota

Se producirá un error al llamar a esta API fuera de la implementación del método IVpnPlugin.Connect en un complemento VPN.

El uso del mecanismo de activación en primer plano requiere controlar la activación en varios lugares.

En el método IVpnPlugin.Connect , llamará a ActivateForeground con el identificador de aplicación relativo al paquete (PRAID) correcto y un ValueSet que contiene todos los valores que desea enviar a la aplicación en primer plano.

En la aplicación en primer plano, debe detectar la activación. La aplicación en primer plano se activará con un valor Windows.ApplicationModel.ActivationKind de VpnForeground. Los argumentos de activación serán de tipo Windows.Networking.Vpn.VpnForegroundActivatedEventArgs e incluirán tres campos.

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

La aplicación en primer plano puede configurar la interfaz de usuario (UI) de la aplicación para controlar la autorización necesaria (o los datos necesarios). Cuando haya terminado, debe llamar al método Complete de ActivationOperation, pasando un ValueSet de valores que desea devolver a la llamada A IVpnPlugin.Connect .

De nuevo en la llamada A IVpnPlugin.Connect , use valueSet devuelto desde ActivateForeground para decidir si la autenticación se realizó correctamente y controlar los errores.