Context for the current request.
Optional
domain?: stringThe domain (not the page URL) that this request originated from.
This may not be set, and might also be set to fake values. Trust the client.
Whether this request is a "forced" or manually invoked action.
How to interpret this is up to you but, as an example, other transports will skip caches when this is true
.
A unique identifier for this image request.
You can use this ID internally if you want, the important part is for this ID to be present in the response body.
The current user preferences to be used with this request.
Optional
requestAn optional collection of additional key-value pairs for use with this request. Some clients may not specify these.
Always check this carefully as some requests will not include any keys, and not all keys will be relevant to all backends (or clients for that matter).
An identifier for the source context of the current request. In browsers, this is the tab ID.
This should not be used to differentiate requests (that's the id
) but can be used to group requests.
Optional
srcThe original URL of the image as it appeared for the user (i.e. its HTTP URI for browser contexts).
This will not always be set, but if the url
property is a Data URI this should be the original HTTP URI
for clients that don't support/understand Data URIs.
The URL of the image to be censored. Note that this can be a HTTP(S) URI or a Data URI.
Generated using TypeDoc
The request message sent to censoring backends to censor an image.