background("clear")— remove the current chat background.background("./photo.jpg")— set background from a filesystem path. MIME type is inferred from the extension; override withoptions.mimeType.background(new URL("https://…/photo.jpg"))— fetch the background lazily over the network. Bytes stay in memory (safe in read-only environments). MIME type is inferred from the URL pathname extension; override withoptions.mimeTypewhen the URL has no usable extension.background(buffer, { mimeType })— set background from in-memory bytes.options.mimeTypeis required.
"clear" is a reserved string-literal sentinel. If you have a file literally
named clear with no extension, pass "./clear" or load it as a Buffer.
space.send(background(...)) is the canonical form; space.background(...)
is sugar attached via PlatformDef.space.actions (only typed on
PlatformSpace<IMessageDef>).
Background is intentionally not a member of the universal Content
union — the as unknown as Content cast keeps the builder shape compatible
with the framework’s ContentBuilder.build(): Promise<Content> signature.
The framework treats it as a fire-and-forget control signal at runtime.
Parameters
"clear"
required
Returns
ContentBuilder
background("clear")— remove the current chat background.background("./photo.jpg")— set background from a filesystem path. MIME type is inferred from the extension; override withoptions.mimeType.background(new URL("https://…/photo.jpg"))— fetch the background lazily over the network. Bytes stay in memory (safe in read-only environments). MIME type is inferred from the URL pathname extension; override withoptions.mimeTypewhen the URL has no usable extension.background(buffer, { mimeType })— set background from in-memory bytes.options.mimeTypeis required.
"clear" is a reserved string-literal sentinel. If you have a file literally
named clear with no extension, pass "./clear" or load it as a Buffer.
space.send(background(...)) is the canonical form; space.background(...)
is sugar attached via PlatformDef.space.actions (only typed on
PlatformSpace<IMessageDef>).
Background is intentionally not a member of the universal Content
union — the as unknown as Content cast keeps the builder shape compatible
with the framework’s ContentBuilder.build(): Promise<Content> signature.
The framework treats it as a fire-and-forget control signal at runtime.
Parameters
string | Buffer<ArrayBufferLike> | URL
required
{ mimeType: string }
Returns
ContentBuilder