set_cookie_response {cookies} | R Documentation |
Set cookie via HTTP header
Description
Send a shiny::httpResponse()
that sets a cookie in the user's browser. Note
that this does not return a full shiny ui.
Usage
set_cookie_response(
cookie_name,
cookie_value,
expiration = 90,
secure_only = NULL,
domain = NULL,
path = NULL,
same_site = NULL,
http_only = FALSE,
redirect = NULL,
...
)
Arguments
cookie_name |
The name of the cookie. Can contain any US-ASCII characters except for: the control character, space, a tab, or separator characters like ( ) < > @ , ; : \ " / [ ] ? = { }. |
cookie_value |
The contents of the cookie as a single character value. |
expiration |
Days after which the cookie should expire. To remove an HttpOnly cookie, send a negative value for this attribute. |
secure_only |
Logical indicating whether the cookie should only be
accessible via secure ( |
domain |
The host to which the cookie will be sent (including
subdomains). If this is |
path |
The path that must exist in the requested URL for the browser to send this cookie. Includes subdirectories. |
same_site |
One of "strict", "lax" (default), or "none", indicating when
the cookie should be sent. When |
http_only |
Logical indicating whether the cookie should only be sent as
part of an HTTP request. When this is |
redirect |
A relative or absolute URL where the user should be sent next. A typical case would be the same URL minus the query parameter that triggered the Set-cookie response. |
... |
Additional parameters passed on to |
Value
A shiny::httpResponse()
that sets the cookie.
Examples
set_cookie_response("my_cookie", "contents of my cookie")
set_cookie_response("my_cookie", "contents of my cookie", expiration = 10)
set_cookie_response(
"my_cookie", "contents of my cookie",
content = "Your cookie is set."
)
set_cookie_response(
"my_cookie", "contents of my cookie",
redirect = "/"
)