IPWorks WebSockets 2020 macOS Edition

Questions / Feedback?

HTTPCookie Type

An HTTP cookie either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It may also store the cookies set by the server.

Cookies that are to be sent to the server must have the Name and Value fields supplied prior to submitting the URL. However, when the SetCookie event is fired, all of the fields of an HTTPCookie are filled out accordingly.

Fields

domain
String

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

expiration
String

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

name
String

The name of the cookie.

This property, along with Value store the cookie that is to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

path
String

This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

secure
Bool

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted through a secure (HTTPS) connection only.

value
String

This property contains the value of the cookie. The cookie specified by Name has a corresponding value associated with it. This property holds that value.

The SetCookie event provides the cookies set by the server.

Constructors

public init()
public init(name: String, value: String)

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 macOS Edition - Version 20.0 [Build 7941]