Skip to main content

SafeUser

Class

Represents a user of the current runtime with only non-sensitive information (Bitmoji info).

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

Represents a user of the current runtime with only non-sensitive information (Bitmoji info). This is a safe subset of user data that works with Lenses that use sensitive apis. Check SafeUser#accountType to find out which kind of account backs this user.

Index

Extends

Extended by

Properties

accountType

readonly accountType: AccountType

The kind of account backing this user — AccountType Snapchat or Specs. Branch on this rather than inspecting the concrete class.

Since

Lens Scripting Version 378

Example

global.userContextSystem.getCurrentUser(function (user) {
if (user.accountType === AccountType.Snapchat) {
print("Snapchat account");
} else if (user.accountType === AccountType.Specs) {
print("Specs account");
}
});

hasBitmoji

readonly hasBitmoji: boolean

Whether this user has a Bitmoji that can be retrieved via BitmojiModule.

Methods

getTypeName()

static getTypeName(): TypeName<SafeUser>

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

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