From 15af522e354bebd595d1e3cb72abf510ad7dcde9 Mon Sep 17 00:00:00 2001 From: or-else Date: Tue, 26 Nov 2019 21:23:27 +0300 Subject: [PATCH] describe `sub.bkg` --- docs/API.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/API.md b/docs/API.md index a61e47584..dc6e062a3 100644 --- a/docs/API.md +++ b/docs/API.md @@ -686,8 +686,9 @@ The `{sub}` message may include a `get` and `set` fields which mirror `{get}` an ```js sub: { id: "1a2b3", // string, client-provided message id, optional - topic: "me", // topic to be subscribed or attached to - + topic: "me", // topic to be subscribed or attached to + bkg: true, // request to attach to topic is issued by an automated agent, server should delay sending + // presence notifications because the agent is expected to disconnect very quickly // Object with topic initialisation data, new topics & new // subscriptions only, mirrors {set} message set: {