Поделиться через


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

Определение

Активирует приложение VPN на переднем плане. Это часто используется, чтобы позволить пользователю ввести учетные данные. АктивироватьForeground можно вызывать только из реализации IVpnPlugin.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, содержащий объект среда выполнения 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.ActivationKindVpnForeground. Аргументы активации будут иметь тип Windows.Networking.Vpn.VpnForegroundActivatedEventArgs и будут содержать три поля.

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

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

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

Применяется к