Child pages
  • Cookie

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
{hidden} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden} {sub-section:description|text=}{sub-section}\\ {table:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#getComment]\() Returns the cookie comment.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDomain]\() Returns the cookie domain.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getName]\() Returns the cookie name.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getPath]\() Returns the cookie path.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#getSecure]\() Returns the cookie secure attribute.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getValue]\() Returns the cookie value.{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getComment|class=node}{tr:id=name}{td}h6.getComment{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getComment{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getComment_des|text=|trigger=button}{sub-section}{sub-section:getComment_des|trigger=none|class=sIndent}Returns the cookie comment.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getComment_snc|text=|trigger=button}{sub-section}{sub-section:getComment_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getComment_prs|text=|trigger=button}{sub-section}{sub-section:getComment_prs|trigger=none|class=sIndent} {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getComment_ret|text=|trigger=button}{sub-section}{sub-section:getComment_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getComment_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getComment_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getComment_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getComment_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getComment_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getComment_sam|trigger=none}{code:language=javascript}
Wiki Markup
Div
styledisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getComment()
Returns the cookie comment.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getDomain()
Returns the cookie domain.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getName()
Returns the cookie name.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getPath()
Returns the cookie path.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
getSecure()
Returns the cookie secure attribute.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getValue()
Returns the cookie value.



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetComment
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getComment
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the cookie comment.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var cookie = client.getCookie('cookieName')
var path = cookie.getComment();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDomain|class=node}{tr:id=name}{td}h6.getDomain{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getDomain{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getDomain_des|text=|trigger=button}{sub-section}{sub-section:getDomain_des|trigger=none|class=sIndent}Returns the cookie domain.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getDomain_snc|text=|trigger=button}{sub-section}{sub-section:getDomain_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getDomain_prs|text=|trigger=button}{sub-section}{sub-section:getDomain_prs|trigger=none|class=sIndent} {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getDomain_ret|text=|trigger=button}{sub-section}{sub-section:getDomain_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getDomain_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDomain_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getDomain_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDomain_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getDomain_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDomain_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDomain
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getDomain
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the cookie domain.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var cookie = client.getCookie('cookieName')
var domain = cookie.getDomain();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getName|class=node}{tr:id=name}{td}h6.getName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getName_des|text=|trigger=button}{sub-section}{sub-section:getName_des|trigger=none|class=sIndent}Returns the cookie name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getName_snc|text=|trigger=button}{sub-section}{sub-section:getName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getName_prs|text=|trigger=button}{sub-section}{sub-section:getName_prs|trigger=none|class=sIndent} {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getName_ret|text=|trigger=button}{sub-section}{sub-section:getName_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getName_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getName_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getName_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getName_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetName
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the cookie name.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var cookie = client.getCookie('cookieName')
var name = cookie.getName();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getPath|class=node}{tr:id=name}{td}h6.getPath{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getPath{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getPath_des|text=|trigger=button}{sub-section}{sub-section:getPath_des|trigger=none|class=sIndent}Returns the cookie path.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getPath_snc|text=|trigger=button}{sub-section}{sub-section:getPath_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getPath_prs|text=|trigger=button}{sub-section}{sub-section:getPath_prs|trigger=none|class=sIndent} {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getPath_ret|text=|trigger=button}{sub-section}{sub-section:getPath_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getPath_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getPath_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getPath_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getPath_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getPath_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getPath_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetPath
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getPath
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the cookie path.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var cookie = client.getCookie('cookieName')
var path = cookie.getPath();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSecure|class=node}{tr:id=name}{td}h6.getSecure{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}getSecure{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getSecure_des|text=|trigger=button}{sub-section}{sub-section:getSecure_des|trigger=none|class=sIndent}Returns the cookie secure attribute.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getSecure_snc|text=|trigger=button}{sub-section}{sub-section:getSecure_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getSecure_prs|text=|trigger=button}{sub-section}{sub-section:getSecure_prs|trigger=none|class=sIndent} {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getSecure_ret|text=|trigger=button}{sub-section}{sub-section:getSecure_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getSecure_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSecure_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getSecure_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSecure_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getSecure_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSecure_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetSecure
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
getSecure
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the cookie secure attribute.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var cookie = client.getCookie('cookieName')
var path = cookie.getSecure();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getValue|class=node}{tr:id=name}{td}h6.getValue{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getValue{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getValue_des|text=|trigger=button}{sub-section}{sub-section:getValue_des|trigger=none|class=sIndent}Returns the cookie value.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getValue_snc|text=|trigger=button}{sub-section}{sub-section:getValue_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getValue_prs|text=|trigger=button}{sub-section}{sub-section:getValue_prs|trigger=none|class=sIndent} {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getValue_ret|text=|trigger=button}{sub-section}{sub-section:getValue_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getValue_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getValue_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getValue_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getValue_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getValue_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getValue_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetValue
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getValue
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the cookie value.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var cookie = client.getCookie('cookieName')
var value = cookie.getValue();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Table Row (tr)
classlastDetailRow
Table Cell (td)