SetDetails constructor

SetDetails({
  1. required String url,
  2. String? name,
  3. String? value,
  4. String? domain,
  5. String? path,
  6. bool? secure,
  7. bool? httpOnly,
  8. SameSiteStatus? sameSite,
  9. double? expirationDate,
  10. String? storeId,
  11. CookiePartitionKey? partitionKey,
})

Implementation

SetDetails({
  /// The request-URI to associate with the setting of the cookie. This value
  /// can affect the default domain and path values of the created cookie. If
  /// host permissions for this URL are not specified in the manifest file,
  /// the API call will fail.
  required String url,

  /// The name of the cookie. Empty by default if omitted.
  String? name,

  /// The value of the cookie. Empty by default if omitted.
  String? value,

  /// The domain of the cookie. If omitted, the cookie becomes a host-only
  /// cookie.
  String? domain,

  /// The path of the cookie. Defaults to the path portion of the url
  /// parameter.
  String? path,

  /// Whether the cookie should be marked as Secure. Defaults to false.
  bool? secure,

  /// Whether the cookie should be marked as HttpOnly. Defaults to false.
  bool? httpOnly,

  /// The cookie's same-site status. Defaults to "unspecified", i.e., if
  /// omitted, the cookie is set without specifying a SameSite attribute.
  SameSiteStatus? sameSite,

  /// The expiration date of the cookie as the number of seconds since the
  /// UNIX epoch. If omitted, the cookie becomes a session cookie.
  double? expirationDate,

  /// The ID of the cookie store in which to set the cookie. By default, the
  /// cookie is set in the current execution context's cookie store.
  String? storeId,

  /// The partition key for reading or modifying cookies with the Partitioned
  /// attribute.
  CookiePartitionKey? partitionKey,
}) : _wrapped = $js.SetDetails(
        url: url,
        name: name,
        value: value,
        domain: domain,
        path: path,
        secure: secure,
        httpOnly: httpOnly,
        sameSite: sameSite?.toJS,
        expirationDate: expirationDate,
        storeId: storeId,
        partitionKey: partitionKey?.toJS,
      );