Object - http : CookieStore

Represents the cookie store.

Constructor

__init

(PersistentCookieHandler? persistentCookieHandler)

Methods

Adds a cookie to the cookie store according to the rules in

Adds an array of cookies.

Gets the relevant cookies for the given URL and the path according to the rules in

Gets all the cookies in the cookie store.

Gets all the cookies, which have the given name as the name of the cookie.

Gets all the cookies, which have the given name as the domain of the cookie.

Removes a specific cookie.

Removes cookies, which match with the given domain.

Removes all expired cookies.

Removes all the cookies.

addCookie

(Cookie cookie, CookieConfig cookieConfig, string url, string requestPath)

returns CookieHandlingError?

Adds a cookie to the cookie store according to the rules in RFC-6265.

Parameters

  • cookie Cookie
  • Cookie to be added

  • cookieConfig CookieConfig
  • Configurations associated with the cookies

  • url string
  • Target service URL

  • requestPath string
  • Resource path

  • Return Type

    (CookieHandlingError?)
  • An http:CookieHandlingError if there is any error occurred when adding a cookie or else ()

addCookies

Adds an array of cookies.

Parameters

  • cookiesInResponse Cookie[]
  • Cookies to be added

  • cookieConfig CookieConfig
  • Configurations associated with the cookies

  • url string
  • Target service URL

  • requestPath string
  • Resource path

getCookies

(string url, string requestPath)

returns Cookie[]

Gets the relevant cookies for the given URL and the path according to the rules in RFC-6265.

Parameters

  • url string
  • URL of the request URI

  • requestPath string
  • Path of the request URI

  • Return Type

    (Cookie[])
  • Array of the matched cookies stored in the cookie store

getAllCookies

()

returns Cookie[]

Gets all the cookies in the cookie store.

  • Return Type

    (Cookie[])
  • Array of all the cookie objects

getCookiesByName

(string cookieName)

returns Cookie[]

Gets all the cookies, which have the given name as the name of the cookie.

Parameters

  • cookieName string
  • Name of the cookie

  • Return Type

    (Cookie[])
  • Array of all the matched cookie objects

getCookiesByDomain

(string domain)

returns Cookie[]

Gets all the cookies, which have the given name as the domain of the cookie.

Parameters

  • domain string
  • Name of the domain

  • Return Type

    (Cookie[])
  • Array of all the matched cookie objects

removeCookie

(string name, string domain, string path)

returns CookieHandlingError?

Removes a specific cookie.

Parameters

  • name string
  • Name of the cookie to be removed

  • domain string
  • Domain of the cookie to be removed

  • path string
  • Path of the cookie to be removed

  • Return Type

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

removeCookiesByDomain

(string domain)

returns CookieHandlingError?

Removes cookies, which match with the given domain.

Parameters

  • domain string
  • Domain of the cookie to be removed

  • Return Type

    (CookieHandlingError?)
  • An http:CookieHandlingError if there is any error occurred during the removal of cookies by domain or else ()

removeExpiredCookies

()

returns CookieHandlingError?

Removes all expired cookies.

  • Return Type

    (CookieHandlingError?)
  • An http:CookieHandlingError if there is any error occurred during the removal of expired cookies or else ()

removeAllCookies

()

returns CookieHandlingError?

Removes all the cookies.

  • Return Type

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