Interface UserInfo

Provides information about a user in a Connected Lens session.

interface UserInfo {
    connectionId: string;
    displayName: string;
    joinServerTimeMilliseconds: number;
    userId: string;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

connectionId displayName joinServerTimeMilliseconds userId

Methods

getTypeName isOfType isSame

Properties

ReadonlyconnectionId

connectionId: string

ReadonlydisplayName

displayName: string

The current display name of the user.

ReadonlyjoinServerTimeMilliseconds

joinServerTimeMilliseconds: number

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

ReadonlyuserId

userId: string

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

Methods

getTypeName

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods