Cookie abstract interface

abstract interface class Cookie

Representation of a cookie. For cookies received by the server as Cookie header values only name and value properties will be set. When building a cookie for the 'set-cookie' header in the server and when receiving cookies in the client as 'set-cookie' headers all fields can be used.

Constructors

Cookie() factory

factory Cookie(String name, String value)

Creates a new cookie setting the name and value.

name and value must be composed of valid characters according to RFC 6265.

By default the value of httpOnly will be set to true.

Implementation

factory Cookie(String name, String value) => _Cookie(name, value);

Cookie.fromSetCookieValue() factory

factory Cookie.fromSetCookieValue(String value)

Creates a new cookie by parsing a header value from a 'set-cookie' header.

Implementation

factory Cookie.fromSetCookieValue(String value) {
  return _Cookie.fromSetCookieValue(value);
}

Properties

domain read / write

String? domain

getter:

The domain that the cookie applies to.

setter:

The domain that the cookie applies to.

Implementation

abstract String? domain;

expires read / write

DateTime? expires

getter:

The time at which the cookie expires.

setter:

The time at which the cookie expires.

Implementation

abstract DateTime? expires;

hashCode no setter inherited

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation

external int get hashCode;

httpOnly read / write

bool httpOnly

getter:

Whether the cookie is only sent in the HTTP request and is not made available to client side scripts.

setter:

Whether the cookie is only sent in the HTTP request and is not made available to client side scripts.

Implementation

abstract bool httpOnly;

maxAge read / write

int? maxAge

getter:

The number of seconds until the cookie expires. A zero or negative value means the cookie has expired.

setter:

The number of seconds until the cookie expires. A zero or negative value means the cookie has expired.

Implementation

abstract int? maxAge;

name read / write

String name

getter:

The name of the cookie.

Must be a token as specified in RFC 6265.

The allowed characters in a token are the visible ASCII characters, U+0021 (!) through U+007E (~), except the separator characters: (, ), <, >, @, ,, ;, :, \, ", /, [, ], ?, =, {, and }.

setter:

The name of the cookie.

Must be a token as specified in RFC 6265.

The allowed characters in a token are the visible ASCII characters, U+0021 (!) through U+007E (~), except the separator characters: (, ), <, >, @, ,, ;, :, \, ", /, [, ], ?, =, {, and }.

Implementation

abstract String name;

path read / write

String? path

getter:

The path within the domain that the cookie applies to.

setter:

The path within the domain that the cookie applies to.

Implementation

abstract String? path;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

sameSite read / write

SameSite? sameSite

getter:

Whether the cookie is available from other sites.

This value is null if the SameSite attribute is not present.

See SameSite for more information.

setter:

Whether the cookie is available from other sites.

This value is null if the SameSite attribute is not present.

See SameSite for more information.

Implementation

abstract SameSite? sameSite;

secure read / write

bool secure

getter:

Whether to only send this cookie on secure connections.

setter:

Whether to only send this cookie on secure connections.

Implementation

abstract bool secure;

value read / write

String value

getter:

The value of the cookie.

Must be a cookie-value as specified in RFC 6265.

The allowed characters in a cookie value are the visible ASCII characters, U+0021 (!) through U+007E (~) except the characters: ", ,, ; and \. Cookie values may be wrapped in a single pair of double quotes (U+0022, ").

setter:

The value of the cookie.

Must be a cookie-value as specified in RFC 6265.

The allowed characters in a cookie value are the visible ASCII characters, U+0021 (!) through U+007E (~) except the characters: ", ,, ; and \. Cookie values may be wrapped in a single pair of double quotes (U+0022, ").

Implementation

abstract String value;

Methods

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() override

String toString()

Returns the formatted string representation of the cookie. The string representation can be used for setting the Cookie or 'set-cookie' headers

Implementation

String toString();

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation

external bool operator ==(Object other);