Cookie data type

Official Content
This documentation is valid for:

The Cookie data type enables to create Cookies and set different properties of them in GeneXus web objects.

Properties

Name Is the cookie's name and it is a character type.
Value Is the value to be stored and it is a character type.
Path Is the Path that indicates the Web Panels for which the cookie is valid, and it is also a character type. If it isn’t specified, the cookie is valid for the web panels that are in the same directory as the one it is stored in, or in subordinated directories. If “/” is indicated, the cookie will be valid for the entire domain.
ExpirationDate Indicates the expiration date of the cookie. It is a date/datetime type. If it isn’t specified, it will expire when the session is closed in the browser.
Domain Is the domain where the cookie is valid. It is a character type. The default domain is the domain where it has been created.
Secure Is a numeric type. If it is 1, the cookie is transmitted only if the connection is secure (HTTPS). If it is 0, it is always transmitted.
HttpOnly Is a boolean type. It allows to avoid to save or set a cookie from JavaScript code.

 

Example

In a web panel, &cookie is a variable of Cookie data type, &ok is Numeric data type, and &httpresponse is HttpResponse Data Type. SetCookie function is Used to save cookies.

Event 'SetCookie example'
    &cookie.Name = 'USR_CTRY'
    &cookie.Value = 'UY'
    &cookie.ExpirationDate = ADDYR(&Today, 1)
    &cookie.Domain = 'otherdom.artech.com.uy'
    &cookie.Secure = 1
    &cookie.HttpOnly = true
    &OK = &httpresponse.SetCookie(&cookie) 
EndEvent

 

Availability

From version GeneXus X Evolution 2 Upgrade 3.

 

Scope

Languages Java, .NET, Ruby
Interfaces Web
   

See also

SetCookie function
GetCookie function