Overview

Storage for a browsing session (cookies, local storage, etc.).

#include <Ultralight/CAPI/CAPI_Session.h>

This class stores data for a unique browsing session (cookies, local storage, application cache, indexed db. etc.). You can create multiple sessions to isolate data between different browsing contexts.

Default Session

The library has a default session named "default" that is used if no session is specified when when creating a View.

Session Lifetime

Sessions can be either temporary (in-memory only) or persistent (backed to disk).

Functions
ULSession	ulCreateSession (ULRenderer renderer, bool is_persistent, ULString name)
	Create a Session to store local data in (such as cookies, local storage, application cache, indexed db, etc).
void	ulDestroySession (ULSession session)
	Destroy a Session.
ULSession	ulDefaultSession (ULRenderer renderer)
	Get the default session (persistent session named "default").
bool	ulSessionIsPersistent (ULSession session)
	Whether or not is persistent (backed to disk).
ULString	ulSessionGetName (ULSession session)
	Unique name identifying the session (used for unique disk path).
unsigned long long	ulSessionGetId (ULSession session)
	Unique numeric Id for the session.
ULString	ulSessionGetDiskPath (ULSession session)
	The disk path to write to (used by persistent sessions only).

Function Documentation

◆ ulCreateSession()

ULSession ulCreateSession	(	ULRenderer	renderer,
		bool	is_persistent,
		ULString	name )

Create a Session to store local data in (such as cookies, local storage, application cache, indexed db, etc).

◆ ulDefaultSession()

ULSession ulDefaultSession ( ULRenderer renderer )

Get the default session (persistent session named "default").

Note: This session is owned by the Renderer, you shouldn't destroy it.

◆ ulDestroySession()

void ulDestroySession ( ULSession session )

Destroy a Session.

◆ ulSessionGetDiskPath()

ULString ulSessionGetDiskPath ( ULSession session )

The disk path to write to (used by persistent sessions only).

◆ ulSessionGetId()

unsigned long long ulSessionGetId ( ULSession session )

Unique numeric Id for the session.

◆ ulSessionGetName()

ULString ulSessionGetName ( ULSession session )

Unique name identifying the session (used for unique disk path).

◆ ulSessionIsPersistent()

bool ulSessionIsPersistent ( ULSession session )

Whether or not is persistent (backed to disk).

Go to the source code of this file.