Skip to main content

ConnectedLensModule.ConnectionInfo

Class

Information that is bootstrapped to the user who just connected to the 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

externalUsersInfo

readonly externalUsersInfo: UserInfo[]

Get the information about all the other users connected to the same session.

Since

Lens Scripting Version 177


hostUserInfo

readonly hostUserInfo: UserInfo


localUserInfo

readonly localUserInfo: UserInfo

Get the information about the local user.


realtimeStores

readonly realtimeStores: GeneralDataStore[]

Get all the Realtime Stores that are being used in the session.


realtimeStoresCreationInfos

readonly realtimeStoresCreationInfos: RealtimeStoreCreationInfo[]

Provides creation info about every existing RealtimeStore.

Methods

getTypeName()

static getTypeName(): TypeName<ConnectionInfo>

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<ConnectionInfo>

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