HttpCookie Classe

Definição

Espaço de Nomes:
System.Web
Assemblagem:
System.Web.dll

Fornece uma forma segura para 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 seguinte demonstra como verificar um cookie nomeado DateCookieExample no HttpRequest objeto. Se o cookie não for encontrado, ele é criado e adicionado ao HttpResponse objeto. O biscoito está programado para expirar dentro de 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>

Observações

A HttpCookie classe obtém e define propriedades de cookies individuais. A HttpCookieCollection classe fornece métodos para armazenar, recuperar e gerir múltiplos cookies.

O ASP.NET inclui duas coleções intrínsecas de cookies. A coleção acedida através da Cookies coleção do HttpRequest objeto contém cookies transmitidos pelo cliente ao servidor no Cookie cabeçalho. A coleção acedida através da Cookies coleção do HttpResponse objeto contém novos cookies criados no servidor e transmitidos ao cliente no Set-Cookie cabeçalho de resposta HTTP.

Construtores

Name Description
HttpCookie(String, String)

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

Cria e nomeia um novo cookie.

Propriedades

Name Description
Domain

Obtém ou define o domínio para associar o cookie.
Expires

Obtém ou definem a data de validade e a hora do biscoito.
HasKeys

Recebe um valor que indica se um cookie tem subchaves.
HttpOnly

Recebe ou define um valor que especifica se um cookie é acessível por script do lado do cliente.
Item[String]

Fica com um atalho para a Values propriedade. Esta propriedade é fornecida para compatibilidade com versões anteriores do Active Server Pages (ASP).
Name

Recebe ou define o nome de uma bolacha.
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

Recebe ou define um valor que indica se deve transmitir o cookie usando a Secure Sockets Layer (SSL) — ou seja, apenas por HTTPS.
Shareable

Determina se o cookie pode participar na cache de saída.
Value

Recebe ou define um valor individual de cookie.
Values

Obtém uma coleção de pares chave/valor contidos num único objeto cookie.

Métodos

Name Description
Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetHashCode()

Serve como função de hash predefinida.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do atual Object.

(Herdado de Object)
ToString()

Devolve uma cadeia que representa o objeto atual.

(Herdado de Object)
TryParse(String, HttpCookie)

Converte a representação de cadeia especificada de um cookie para o seu HttpCookie equivalente e devolve um valor que indica se a conversão foi bem-sucedida.

Aplica-se a

Ver também