Objeck Documentation

All Bundles

Cookie

HTTP cookie

Operations

New
AddAttrib
Expire
GetAttrib
GetName
GetValue
RemoveAttrib
SetExpiration
SetName
SetValue
ToShortString
ToString

AddAttrib

Adds a cookie attribute

method : public : AddAttrib(name:String) ~ Bool

Parameters

Name	Type	Description
name	String	attribute name

Return

Type	Description
Bool	true if added, false otherwise

AddAttrib

Adds a cookie attribute

method : public : AddAttrib(name:String, value:String) ~ Bool

Parameters

Name	Type	Description
name	String	attribute name
value	String	attribute value

Return

Type	Description
Bool	true if added, false otherwise

Expire

Sets the cookie to expire

method : public : Expire() ~ Nil

GetAttrib

Get cookie attribute

method : public : GetAttrib(name:String) ~ String

Parameters

Name	Type	Description
name	String	attribute name

Return

Type	Description
String	cookie attribute value

GetName

Get cookie name

method : public : GetName() ~ String

Return

Type	Description
String	cookie name

GetValue

Get cookie value

method : public : GetValue() ~ String

Return

Type	Description
String	cookie value

New

Constructor

New(name:String, value:String, is_debug:Bool)

Parameters

Name	Type	Description
name	String	cookie name
value	String	cookie value
is_debug	Bool	true to display debug information

New

Constructor

New(name:String, value:String)

Parameters

Name	Type	Description
name	String	cookie name
value	String	cookie value

New

Constructor

New(cookie_str:String)

Parameters

Name	Type	Description
cookie_str	String	cookie string

New

Constructor

New(cookie_str:String, is_debug:Bool)

Parameters

Name	Type	Description
cookie_str	String	cookie string
is_debug	Bool	true to display debug information

RemoveAttrib

Removes an attribute

method : public : RemoveAttrib(name:String) ~ Bool

Parameters

Name	Type	Description
name	String	attribute name

Return

Type	Description
Bool	true if added, false otherwise

SetExpiration

Sets the cookie to expiration date

method : public : SetExpiration(expires:System.Time.Date) ~ Bool

Parameters

Name	Type	Description
expires	Date	expiration date

SetName

Set cookie name

method : public : SetName(name:String) ~ Nil

Parameters

Name	Type	Description
name	String	cookie name

SetValue

Set cookie value

method : public : SetValue(value:String) ~ Nil

Parameters

Name	Type	Description
value	String	cookie value

ToShortString

Formats a cookie name and value

method : public : ToShortString() ~ String

Return

Type	Description
String	string formatted cookie name and value

ToString

Formats a cookie into a string

method : public : ToString() ~ String

Return

Type	Description
String	string formatted cookie