CreatingCookieEventArgs Класс

Определение

Предоставляет данные для события CreatingCookie.Provides data for the CreatingCookie event.

public ref class CreatingCookieEventArgs : EventArgs
public class CreatingCookieEventArgs : EventArgs
type CreatingCookieEventArgs = class
    inherit EventArgs
Public Class CreatingCookieEventArgs
Inherits EventArgs
Наследование
CreatingCookieEventArgs

Примеры

В следующем примере показан обработчик событий для CreatingCookie события.The following example shows an event handler for the CreatingCookie event. Обработчик получает значения пользователя из CreatingCookieEventArgs объекта для настройки файла cookie проверки подлинности.The handler retrieves user values from the CreatingCookieEventArgs object to customize the authentication cookie. Обработчик сохраняет значение из CustomCredential свойства в билете проверки подлинности и CookieIsSet задает свойство равным true , чтобы указать, что файл cookie проверки подлинности создан.The handler saves the value from the CustomCredential property in the authentication ticket and sets the CookieIsSet property to true to indicate that the authentication cookie has been created.

void AuthenticationService_CreatingCookie(object sender, 
    System.Web.ApplicationServices.CreatingCookieEventArgs e)
{
    FormsAuthenticationTicket ticket = new
          FormsAuthenticationTicket
            (1,
             e.UserName,
             DateTime.Now,
             DateTime.Now.AddMinutes(30),
             e.IsPersistent,
             e.CustomCredential,
             FormsAuthentication.FormsCookiePath);

    string encryptedTicket =
         FormsAuthentication.Encrypt(ticket);

    HttpCookie cookie = new HttpCookie
         (FormsAuthentication.FormsCookieName,
          encryptedTicket);
    cookie.Expires = DateTime.Now.AddMinutes(30);

    HttpContext.Current.Response.Cookies.Add(cookie);
    e.CookieIsSet = true;
}
Sub AuthenticationService_CreatingCookie(ByVal sender As Object, _
                 ByVal e As System.Web.ApplicationServices.CreatingCookieEventArgs)
    Dim ticket As FormsAuthenticationTicket = New _
       FormsAuthenticationTicket _
        (1, _
         e.Username, _
         DateTime.Now, _
         DateTime.Now.AddMinutes(30), _
         e.IsPersistent, _
         e.CustomCredential, _
         FormsAuthentication.FormsCookiePath)
        
    Dim encryptedTicket As String = FormsAuthentication.Encrypt(ticket)
    
    Dim cookie As HttpCookie = New _
        HttpCookie(FormsAuthentication.FormsCookieName, encryptedTicket)
    cookie.Expires = DateTime.Now.AddMinutes(30)
    
    HttpContext.Current.Response.Cookies.Add(cookie)
    e.CookieIsSet = True
End Sub

Комментарии

Класс предоставляет значения для любого CreatingCookie обработчика событий. CreatingCookieEventArgsThe CreatingCookieEventArgs class supplies values to any CreatingCookie event handler. С помощью свойств этого класса можно получить учетные данные пользователя при создании пользовательского файла cookie для проверки подлинности.By using the properties of this class, you can retrieve user credentials when you create a custom authentication cookie.

AuthenticationService КлассCreatingCookie вызывает событие, когда задается файл cookie проверки подлинности, после того как учетные данные пользователя прошли проверку подлинности.The AuthenticationService class raises the CreatingCookie event when it sets the authentication cookie, after the user credentials have been authenticated. Класс конструирует CreatingCookieEventArgs объект и передает его в любой CreatingCookie обработчик событий. AuthenticationServiceThe AuthenticationService class constructs a CreatingCookieEventArgs object and passes it to any CreatingCookie event handler.

Вы получаете учетные данные пользователя с UserNameпомощью Passwordсвойств CustomCredential и.You retrieve the user credentials through the UserNamePassword, and CustomCredential properties. CustomCredential Свойство может содержать любые пользовательские значения, необходимые для проверки подлинности, например идентификационный номер.The CustomCredential property can contain any custom values that you need in order to authenticate, such as an identification number. IsPersistent Свойство указывает, следует ли хранить файл cookie проверки подлинности после текущего сеанса.The IsPersistent property indicates whether the authentication cookie should be retained past the current session. Задайте для true AuthenticationService свойства значение, если создается файл cookie для проверки подлинности, чтобы класс не был создан в файле cookie. CookieIsSetSet the CookieIsSet property to true if you create the authentication cookie, so that the AuthenticationService class does not create the cookie.

Свойства

CookieIsSet

Возвращает или задает значение, позволяющее определить, был ли создан файл Cookie для проверки подлинности.Gets or sets a value that indicates whether the authentication cookie has been created.

CustomCredential

Возвращает дополнительные значения проверки подлинности, которые были указаны пользователем.Gets additional authentication values that are provided by the user.

IsPersistent

Возвращает значение, позволяет определить, нужно ли сохранять файл Cookie для проверки подлинности после завершения текущего сеанса.Gets a value that indicates whether the authentication cookie should be retained beyond the current session.

Password

Возвращает пароль пользователя.Gets the password for the user.

UserName

Получает имя для пользователя.Gets the name for the user.

Методы

Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

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

Дополнительно