HttpCookie Classe

Referência

Definição

Namespace:: System.Web

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Fornece uma maneira fortemente tipada de criar e manipular cookies HTTP individuais.

public ref class HttpCookie sealed

public sealed class HttpCookie

type HttpCookie = class

Public NotInheritable Class HttpCookie

Herança: Object
HttpCookie

Exemplos

O exemplo de código a seguir demonstra como verificar se há um cookie nomeado DateCookieExample no HttpRequest objeto. Se o cookie não for encontrado, ele será criado e adicionado ao HttpResponse objeto. O cookie está definido para expirar em 10 minutos.

<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    protected void Page_Load(object sender, EventArgs e)
    {
        StringBuilder sb = new StringBuilder();
        // Get cookie from the current request.
        HttpCookie cookie = Request.Cookies.Get("DateCookieExample");
        
        // Check if cookie exists in the current request.
        if (cookie == null)
        {
            sb.Append("Cookie was not received from the client. ");
            sb.Append("Creating cookie to add to the response. <br/>");
            // Create cookie.
            cookie = new HttpCookie("DateCookieExample");
            // Set value of cookie to current date time.
            cookie.Value = DateTime.Now.ToString();
            // Set cookie to expire in 10 minutes.
            cookie.Expires = DateTime.Now.AddMinutes(10d);
            // Insert the cookie in the current HttpResponse.
            Response.Cookies.Add(cookie);
        }
        else
        {
            sb.Append("Cookie retrieved from client. <br/>");
            sb.Append("Cookie Name: " + cookie.Name + "<br/>");
            sb.Append("Cookie Value: " + cookie.Value + "<br/>");
            sb.Append("Cookie Expiration Date: " + 
                cookie.Expires.ToString() + "<br/>");
        }
        Label1.Text = sb.ToString();
    }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>HttpCookie Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:Label id="Label1" runat="server"></asp:Label>
    </div>
    </form>
</body>
</html>

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
        Dim sb As New StringBuilder()
        ' Get cookie from current request.
        Dim cookie As HttpCookie
        cookie = Request.Cookies.Get("DateCookieExample")
        
        ' Check if cookie exists in the current request
        If (cookie Is Nothing) Then
            sb.Append("Cookie was not received from the client. ")
            sb.Append("Creating cookie to add to the response. <br/>")
            ' Create cookie.
            cookie = New HttpCookie("DateCookieExample")
            ' Set value of cookie to current date time.
            cookie.Value = DateTime.Now.ToString()
            ' Set cookie to expire in 10 minutes.
            cookie.Expires = DateTime.Now.AddMinutes(10D)
            ' Insert the cookie in the current HttpResponse.
            Response.Cookies.Add(cookie)
        Else
            sb.Append("Cookie retrieved from client. <br/>")
            sb.Append("Cookie Name: " + cookie.Name + "<br/>")
            sb.Append("Cookie Value: " + cookie.Value + "<br/>")
            sb.Append("Cookie Expiration Date: " & _
                cookie.Expires.ToString() & "<br/>")
        End If
        Label1.Text = sb.ToString()

    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>HttpCookie Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:Label id="Label1" runat="server"></asp:Label>    
    </div>
    </form>
</body>
</html>

Comentários

A HttpCookie classe obtém e define propriedades de cookies individuais. A HttpCookieCollection classe fornece métodos para armazenar, recuperar e gerenciar vários cookies.

ASP.NET inclui duas coleções de cookie intrínsecos. A coleção acessada por meio da Cookies coleção do HttpRequest objeto contém cookies transmitidos pelo cliente para o servidor no Cookie cabeçalho. A coleção acessada por meio da Cookies coleção do HttpResponse objeto contém novos cookies criados no servidor e transmitidos para o cliente no cabeçalho de Set-Cookie resposta HTTP.

Construtores

HttpCookie(String)	Cria e nomeia um novo cookie.
HttpCookie(String, String)	Cria, nomeia e atribui um valor a um novo cookie.

Propriedades

Domain	Obtém ou define o domínio a ser associado ao cookie.
Expires	Obtém ou define a data e hora de expiração do cookie.
HasKeys	Obtém um valor que indica se o um cookie tem subchaves.
HttpOnly	Obtém ou define um valor que especifica se um cookie é acessível pelo script do lado do cliente.
Item[String]	Obtém um atalho para a propriedade Values. Esta propriedade é fornecida para compatibilidade com versões anteriores de ASP (Active Server Pages).
Name	Obtém ou define o nome de um cookie.
Path	Obtém ou define o caminho virtual para transmitir com o cookie atual.
SameSite	Obtém ou define o valor do atributo SameSite do cookie.
Secure	Obtém ou define um valor indicando se deve transmitir o cookie usando o protocolo SSL, isto é, apenas via HTTPS.
Shareable	Determina se o cookie tem permissão para participar do cache de saída.
Value	Obtém ou define um valor de cookie individual.
Values	Obtém uma coleção de pares chave-valor que estão contidos em um único objeto de cookie.

Métodos

Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
TryParse(String, HttpCookie)	Converte a representação de cadeia de caracteres especificada de um cookie em seu HttpCookie equivalente e retorna um valor que indica se a conversão foi bem-sucedida.

Aplica-se a

Compartilhar via