Class: InstantClient

NutrientViewer.InstantClient
Server Only

An InstantClient describes a single connection of a given user with the server.

This class is only available if you have a valid Nutrient Instant license.

You can retrieve an instance of InstantClient by using NutrientViewer.Instance#connectedClients.

Members



Members

(readonly) clientId: string
Server Only

A unique ID string for every connected client. It does not persist across client reconnects.

Type:
  • string

(readonly, nullable) userId: string
Server Only

A user ID of the client. This ID is supplied by your backend. If the value is null, the client is considered anonymous.

Type:
  • string