Object - http : PersistentCookieHandler

The representation of a persistent cookie handler for managing persistent cookies.

Methods

Adds a persistent cookie to the cookie store.

Gets all persistent cookies.

Removes a specific persistent cookie.

Removes all persistent cookies.

storeCookie

(Cookie cookie)

returns CookieHandlingError?

Adds a persistent cookie to the cookie store.

Parameters

  • cookie Cookie
  • Cookie to be added

  • Return Type

    (CookieHandlingError?)
  • An http:CookieHandlingError if there is any error occurred during the storing process of the cookie or else ()

getAllCookies

()

returns Cookie[] | CookieHandlingError

Gets all persistent cookies.

  • Return Type

    (Cookie[] | CookieHandlingError)
  • Array of persistent cookies stored in the cookie store or else an http:CookieHandlingError if one occurred during the retrieval of the cookies

removeCookie

(string name, string domain, string path)

returns CookieHandlingError?

Removes a specific persistent cookie.

Parameters

  • name string
  • Name of the persistent cookie to be removed

  • domain string
  • Domain of the persistent cookie to be removed

  • path string
  • Path of the persistent cookie to be removed

  • Return Type

    (CookieHandlingError?)
  • An http:CookieHandlingError if there is one occurred during the removal of the cookie or else ()

removeAllCookies

()

returns CookieHandlingError?

Removes all persistent cookies.

  • Return Type

    (CookieHandlingError?)
  • An http:CookieHandlingError if there is one occurred during the removal of all the cookies or else ()