Skip to main content

ConnectedLensModule.UserInfo

Class

Provides information about a user in a Connected Lens session.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Index

Extends

Properties

connectionId

readonly connectionId: string

Since

Lens Scripting Version 179


displayName

readonly displayName: string

The current display name of the user.

Since

Lens Scripting Version 148


joinServerTimeMilliseconds

readonly joinServerTimeMilliseconds: number

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

Since

Lens Scripting Version 181


userId

readonly userId: string

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

Since

Lens Scripting Version 148

Methods

getTypeName()

static getTypeName(): TypeName<UserInfo>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<UserInfo>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame