VpnChannel.ActivateForeground(String, ValueSet) Метод

Определение

Пространство имен:

Windows.Networking.Vpn

Активирует VPN-приложение на переднем плане. Это часто используется для ввода учетных данных пользователем. Вы можете вызывать ActivateForeground только из реализации IVpnPlugin.Connect. Хотя приложение находится на переднем плане, обычное Connect время ожидания приостановлено.

Вызов ActivateForeground будет отменен при длительной приостановке (около 10 минут). Если не удается запустить, подключаемый модуль в идеале должен поддерживать метод проверки подлинности, который не нуждается в пользовательском интерфейсе.

Предназначено для поддержки схем проверки подлинности на основе веб-сайтов, таких как язык разметки утверждений безопасности (SAML) и проверка подлинности 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

Параметры

packageRelativeAppId

String

Platform::String

winrt::hstring

Строка, содержащая идентификатор приложения относительно пакета (PRAID) для запуска приложения переднего плана.

sharedContext

ValueSet

Объект ValueSet, используемый для передачи информации в приложение переднего плана. Приложение переднего плана может получить доступ к этим данным из аргументов события активации.

Возвращаемое значение

ValueSet

Объект ValueSet, содержащий объект среды выполнения Windows, который передается обратно из приложения переднего плана в подключаемый модуль VPN, указывающий результат запроса переднего плана.

Требования к Windows

Семейство устройств	Windows 11 (появилось в 10.0.22000.0)
API contract	Windows.Foundation.UniversalApiContract (появилось в v14.0)
Возможности приложения	networkingVpnProvider

Комментарии

Заметка

Вызов этого API за пределами IVpnPlugin.Connect реализации метода в подключаемом модуле VPN завершится ошибкой.

Использование механизма активации переднего плана требует обработки активации в нескольких местах.

В методе IVpnPlugin.Connect вы вызовете ActivateForeground с правильным идентификатором приложения относительного пакета (PRAID) и ValueSet со всеми значениями, которые необходимо отправить в приложение переднего плана.

В приложении переднего плана необходимо поймать активацию. Приложение переднего плана будет активировано со значением Windows.ApplicationModel.ActivationKind значение VpnForeground. Аргументы активации будут иметь тип Windows.Networking.Vpn.VpnForegroundActivatedEventArgsи будут содержать три поля.

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

Затем приложение переднего плана может настроить пользовательский интерфейс приложения для обработки необходимой авторизации (или любых необходимых данных). По завершении необходимо вызвать метод CompleteActivationOperation, передав ValueSet значений, которые необходимо вернуть в вызов IVpnPlugin.Connect.

Вернитесь в вызов IVpnPlugin.Connect, используйте ValueSet, возвращенные из ActivateForeground, чтобы решить, была ли проверка подлинности успешной и обрабатывать любые ошибки.