Class UserInfo

Provides information about a user in a Connected Lens session.

Hierarchy (View Summary, Expand)

ScriptObject
- UserInfo

Index

Constructors

Properties

connectionId displayName joinServerTimeMilliseconds userId

Methods

getTypeName isOfType isSame

Constructors

`Protected`constructor

new UserInfo(): UserInfo
Returns UserInfo
Overrides ScriptObject.constructor

Properties

`Readonly`connectionId

connectionId: string

`Readonly`displayName

displayName: string

The current display name of the user.

`Readonly`joinServerTimeMilliseconds

joinServerTimeMilliseconds: number

Provides the server timestamp (in milliseconds) that the user joined the session.

`Readonly`userId

userId: string

A unique identifier for each participant of connected lens experience. It is unique per lens for each user.

Methods

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame