PropertyEventMethodIndex
WebSquare.cookie - 5.0_4.4547B.20211124.201933

Deletes, gets, sets cookie data.

Type

engine

Property Summary

Event Summary

Method Summary

delCookie( sName )
Deletes data from the cookie.
getCookie( sName )
Gets data from the cookie.
setCookie( sName , sValue , SameSite )
Sets data in the cookie.
setCookieAsync( sName , sValue , SameSite )
Asynchronously sets data in the cookie.

Property Detail

Event Detail

Method Detail

delCookie( sName )
Deletes cookie data.
Parameter
nametyperequireddescription
sNameStringYcookie name
Sample
WebSquare.cookie.delCookie("globalDebug");
getCookie( sName )
Gets data from the cookie.
Parameter
nametyperequireddescription
sNameStringYcookie name
Return
typedescription
Stringcookie value
Sample
WebSquare.cookie.getCookie("globalDebug");
setCookie( sName , sValue , SameSite )
Sets data in the cookie.
The newly set data will be deleted upon browser termination. (Session Cookie)
Parameter
nametyperequireddescription
sNameStringYcookie name
sValueStringYcookie value
SameSiteStringNSameSite option (None, Lax, Strict)
Sample
WebSquare.cookie.setCookie("globalDebug", "false"); // SameSite 'Lax' WebSquare.cookie.setCookie("globalDebug", "false", "None"); WebSquare.cookie.setCookie("globalDebug", "false", "Strict"); (SameSite Options) "None" : Send cookies both to the same site and the cross site. "Lax" : Apply some exceptions to the Strct setting. (HTTP get method / a href / link href) "Strict" : In case of different domains, cookies cannot be sent.
setCookieAsync( sName , sValue , SameSite )
Asynchronously sets data in the cookie.
The newly set data will be deleted upon browser termination.
Blinking occurs upon the cookie being accessed asynchronously on IE. In this case, setCookieAsync is recommended.
Parameter
nametyperequireddescription
sNameStringYcookie name
sValueStringYcookie value
SameSiteStringNSameSite option (None, Lax, Strict)
Sample
WebSquare.cookie.setCookieAsync("globalDebug", "false"); WebSquare.cookie.setCookie("globalDebug", "false", "None"); WebSquare.cookie.setCookie("globalDebug", "false", "Strict"); (SameSite Options) "None" : Send cookies both to the same site and the cross site. "Lax" : Apply some exceptions to the Strct setting. (HTTP get method / a href / link href) "Strict" : In case of different domains, cookies cannot be sent.