1. Pods
  2. BedSheet 1.3.8
  3. API
  4. HttpSession

const mixinafBedSheet::HttpSession

afBedSheet::HttpSession

(Service) - An injectable const version of WebSession.

This class is proxied and will always refer to the session in the current web request.

containsKey

Source

virtual Bool containsKey(Str key)

Returns true if the session map contains the given key.

Does not create a session if it does not already exist.

delete

Source

abstract Void delete()

Delete this web session which clears both the user agent cookie and the server side session instance. This method must be called before the WebRes is committed otherwise the server side instance is cleared, but the user agent cookie will remain uncleared.

Does not create a session if it does not already exist.

@see web::WebSession

exists

Source

abstract Bool exists()

Returns true if a session exists.

Does not create a session if it does not already exist.

get

Source

@Operator
Obj? get(Str name, Obj? def := null)

Convenience for map.get(name, def).

Does not create a session if it does not already exist.

@see web::WebSession

id

Source

abstract Str id()

Get the unique id used to identify this session.

Calling this will create a session if it doesn't already exist.

@see web::WebSession

isEmpty

Source

virtual Bool isEmpty()

Returns true if the session map is empty.

Does not create a session if it does not already exist.

map

Source

abstract Str:Obj? map()

Application name/value pairs which are persisted between HTTP requests. The values stored in this map must be serializable.

Calling this will create a session if it doesn't already exist.

@see web::WebSession

remove

Source

Void remove(Str name)

Convenience for map.remove(name).

Does not create a session if it does not already exist.

set

Source

@Operator
Void set(Str name, Obj? val)

Convenience for map.set(name, val).

Calling this will create a session if it doesn't already exist.

@see web::WebSession