Class

WebCookieManager


Description

Used to get and set cookies connected with the app.

Methods

Name

Parameters

Returns

Shared

Count

Integer

NameAt

index As Integer

String

Remove

Name As String, Domain As String = "", Path As String = ""

String

Set

Name As String, Expiration As DateTime = Nil, Domain As String = "", Path As String = "", Secure As Boolean = False, HTTPOnly As Boolean = False, SameSiteStrength As WebCookieManager.SameSiteStrengths = WebCookieManager.SameSiteStrengths.Off

Value

Name As String

String

Enumerations

WebCookieManager.SameSiteStrengths

SameSiteStrengths

The site strengths available.

Enum

Description

Lax

If a get request is made to another site by the embedded script/webpage, the app's cookies will be sent.

Off

Cookies will only be sent to servers the browser accesses.

Strict

Cookies will only be sent to the domain in which the app is hosted.

Method descriptions


WebCookieManager.Count

Count As Integer

Returns the number of cookies created by the app.


WebCookieManager.NameAt

NameAt(index As Integer) As String

Returns the name of the cookie at the index passed.


WebCookieManager.Remove

Remove(Name As String, Domain As String = "", Path As String = "") As String

Removes the cookie with the Name, Domain and Path passed.


WebCookieManager.Set

Set(Name As String, Expiration As DateTime = Nil, Domain As String = "", Path As String = "", Secure As Boolean = False, HTTPOnly As Boolean = False, SameSiteStrength As WebCookieManager.SameSiteStrengths = WebCookieManager.SameSiteStrengths.Off)

Sets the cookie to the values passed.


WebCookieManager.Value

Value(Name As String) As String

Returns the cookie whose name was passed.

Notes

Session cookies are deleted by the browser when the browser decides that the session has ended.

Compatibility

Web projects on all supported operating systems.