[sockets.users]

sockets.users is a slot in the sockets namespace, in Hyperlambda, the language of Magic Cloud. Lists connected socket users, optionally filtered by username.

• Returns: Returns one child node per connected socket user matching the optional filter

Arguments

Required arguments come first, then the optional ones in the order they are declared.

Argument	Type	Required	Description
[filter]	string	no	Username filter.
[offset]	int	no	Number of matching users to skip. Default: 0.
[limit]	int	no	Maximum number of users to return. Default: 10.

JSON declaration

This is the complete declaration of sockets.users, as the running system describes it. It is also published as slot.json.

JSON declaration

{
  "name": "sockets.users",
  "description": "Lists connected socket users, optionally filtered by username",
  "signature": {
    "children": {
      "filter": {
        "type": "string",
        "kind": "username",
        "description": "Username filter",
        "required": false,
        "mode": "ValueOrExpression",
        "cardinality": "ZeroOrOne",
        "role": "Option",
        "projection": "Value"
      },
      "offset": {
        "type": "int",
        "description": "Number of matching users to skip",
        "required": false,
        "mode": "ValueOrExpression",
        "cardinality": "ZeroOrOne",
        "default": "0",
        "role": "Option",
        "projection": "Value"
      },
      "limit": {
        "type": "int",
        "description": "Maximum number of users to return",
        "required": false,
        "mode": "ValueOrExpression",
        "cardinality": "ZeroOrOne",
        "default": "10",
        "role": "Option",
        "projection": "Value"
      }
    },
    "output": {
      "mode": "Lambda",
      "kind": "socket-user-list,node-list",
      "element-kind": "socket-user,lambda-tree",
      "description": "Returns one child node per connected socket user matching the optional filter"
    }
  }
}

---

← sockets.user.remove-from-group

all sockets.* slots

sockets.users.count →