Метод Sys.Services AuthenticationService login
Обновлен: Ноябрь 2007
Проверяет подлинность учетных данных пользователя.
Sys.Services.AuthenticationService.login(userName, password, isPersistent, customInfo, redirectUrl, loginCompletedCallback, failedCallback, userContext);
Параметры
Параметр |
Описание |
---|---|
userName |
(Обязательно) Имя пользователя для проверки подлинности. |
password |
Пароль пользователя. Значение по умолчанию — null. |
isPersistent |
Если выданный билет подлинности должен быть постоянным на протяжении нескольких сеансов обозревателя, используется значение true; в противном случае — false. По умолчанию используется значение false. |
redirectUrl |
URL-адрес для перенаправления обозревателя в случае успешной проверки подлинности. Если значение — null, переадресации не происходит. Значение по умолчанию — null. |
customInfo |
Зарезервировано для последующего использования. Значение по умолчанию — null. |
loginCompletedCallback |
Функция, вызываемая после успешного входа в систему. Значение по умолчанию — null. |
failedCallback |
Функция, вызываемая в случае ошибки входа в систему. Значение по умолчанию — null. |
userContext |
Сведения о контексте пользователя, передаваемые в функции обратного вызова. |
Исключения
Тип исключения |
Условие |
---|---|
Значение параметра username равно null. |
Заметки
Если значение параметра redirectUrl не равно null или пустой строке, то после завершения вызова веб-службы проверки подлинности текущая страница обновлена не будет. Если вызов веб-службы завершается успешно, вызывается функция, используемая при завершении входа.
Если значение параметра redirectUrl — null или непустая строка, то после успешного вызова веб-службы страница переадресуется на указанный URL-адрес. URL-адрес перенаправления может представлять собой абсолютный виртуальный путь или полное доменное имя и путь.
При ошибке вызова веб-службы страница не переадресовывается и не обновляется. Вместо этого происходит вызов функции, используемой при ошибке обратного вызова.
Пример
В следующем примере показано использование метода login для проверки учетных данных пользователя. Данный код является частью полного примера, приведенного в описании класса Sys.Services.AuthenticationService.
// This function calls the login method of the
// authentication service to verify
// the credentials entered by the user.
// If the credentials are authenticated, the
// authentication service issues a forms
// authentication cookie.
function OnClickLogin()
{
// Set the default callback functions.
SetDefaultLoginCompletedCallBack();
SetDefaultLogoutCompletedCallBack();
SetDefaultFailedCallBack();
// Call the authetication service to authenticate
// the credentials entered by the user.
Sys.Services.AuthenticationService.login(username.value,
password.value, false,null,null,null,null,"User Context");
}
См. также
Основные понятия
Класс Sys.Services.ProfileService