User
ClassRepresents a user of the current runtime.
- Available on all platforms
Since Lens Scripting v378
Represents a user of the current runtime. This is the account-type-agnostic identity every
Lens can rely on regardless of runtime: on Spectacles the user is backed by a Specs account
(SpecsUser), in the Snapchat app by a Snapchat account (SnapchatUser).
Every field is declared here, so a Lens can read the same properties on any account type;
fields the backing account cannot supply are simply null. Use SafeUser#accountType
when you need to branch on the kind of account rather than on a missing value.
Index
Properties
Methods
Example
global.userContextSystem.getCurrentUser(function (user) {
print("User id: " + user.userId);
if (user.name) {
print("Hi " + user.name);
}
// friendInfo is null on accounts with no friend graph, e.g. a Specs account.
if (user.friendInfo) {
print("Streak: " + user.friendInfo.streak);
}
});
Extends
Extended by
Properties
accountType
readonlyaccountType: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");
}
});
Inherited from
birthday
readonlybirthday:UserBirthday
The user's birth month and day. The month and day will start with the index of 1. Present only when the account provides a birthdate.
Since
Lens Scripting Version 378
displayName
readonlydisplayName:string
The name a user has chosen to be shown as. Note that not all users set a display name, so you should treat this value as such.
Since
Lens Scripting Version 378
friendInfo
readonlyfriendInfo:SnapchatFriendUserInfo
Information about friendship between this user and the active user, like start date and streak.
Only accounts whose runtime serves friend data populate this; it is always null for a
SpecsUser, because Specs accounts have no friend graph today.
Since
Lens Scripting Version 378
hasBitmoji
readonlyhasBitmoji:boolean
Whether this user has a Bitmoji that can be retrieved via BitmojiModule.
Inherited from
userName
readonlyuserName:string
The user's unique userName (@handle). Should not be relied on as a key because it can be changed.
Since
Lens Scripting Version 378
zodiac
readonlyzodiac:Zodiac
This user's zodiac, derived from their birthday.
Since
Lens Scripting Version 378
Methods
getTypeName()
staticgetTypeName():TypeName<User>
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<User>
Since
Lens Scripting Version 378
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean