add() #

Available since 2.22.0

Registers a new realtime subscription on the specified connection.

This method is a backend version of the realtime:subscribe API action.

This connection will then starts to receive realtime messages on the returned roomId.

This method can only be used before the application is started.

Copied to clipboard!

add(
  connection: Connection,
  index: string,
  collection: string,
  filters: JSONObject,
  {
    volatile,
    scope,
    users,
  }: {
    volatile?: JSONObject;
    scope?: "in" | "out" | "all" | "none";
    users?: "in" | "out" | "all" | "none";
  }
): Promise<{ roomId: string; channel: string }>

Argument	Type	Description
connection	Connection	Connection to register the subscription on
index	string	Index name
collection	string	Collection name
filters	JSONObject	Subscription filters
options	JSONObject	Subscription options (volatile, scope and users)

Usage #

Copied to clipboard!

const { roomId, channel } = await app.subscription.add(
  request.context.connection,
  "lamaral",
  "windsurf",
  {
    range: { wind: { gte: 20 } },
  },
  {
    users: "all",
    scope: "in",
    volatile: { name: "Aschen" },
  }
);