Skip to main content

Bitmoji2DOptions

Class

The options used with requestBitmoji2DResource.

  • 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.

Since Lens Scripting v256

Index

Extends

Properties

poseId

poseId: string

The pose id for the 2D Bitmoji.

Since

Lens Scripting Version 265

Default Value

""

user

user: SafeUser

The user which the Bitmoji should represent.

Since

Lens Scripting Version 256

Default Value

null

Methods

create()

static create(): Bitmoji2DOptions

Create the option.

Returns

Bitmoji2DOptions

Since

Lens Scripting Version 256


getTypeName()

static getTypeName(): TypeName<Bitmoji2DOptions>

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

Since

Lens Scripting Version 256

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