Class UserContextSystem

Provides information about the user such as display name, birthday, and current weather. Accessible through global.userContextSystem.

All callbacks will execute as soon as the requested information is available. In some rare cases, the requested information may be completely unavailable, and the callback will never occur.

Note that formatted or localized strings may appear differently to users depending on their region.

Example

global.userContextSystem.requestDisplayName(function(displayName) {
   print("Hello " + displayName);
});

global.userContextSystem.requestWeatherLocalized(function(weatherText) {
    print("The weather outside is: " + weatherText);
});

global.userContextSystem.requestAltitudeFormatted(function(altitude) {
   print("Your altitude is: " + altitude);
});


global.userContextSystem.requestCity(function(city) {
   print("Your city is: " + city);
});

global.userContextSystem.requestBirthdateFormatted(function(birthdate) {
   print("Your birthday is: " + birthdate);
});

Hierarchy (View Summary, Expand)

Constructors

constructor

Methods

getAllFriends getBestFriends getCurrentUser getMyAIUser getTypeName getUsersInCurrentContext isOfType isSame requestAltitudeFormatted requestAltitudeInMeters requestBirthdate requestBirthdateFormatted requestCity requestDisplayName requestTemperatureCelsius requestTemperatureFahrenheit requestTemperatureFormatted requestUsername requestWeatherCondition requestWeatherLocalized

Constructors

Protectedconstructor

Methods

getAllFriends

  • getAllFriends(callback: (data: SnapchatUser[]) => void): void
    Exposes User Data

    Retrieve the Snapchatter's friends list in order to access details like display name, birthdate, or Bitmoji

    Parameters

    Returns void

getBestFriends

  • getBestFriends(callback: (data: SnapchatUser[]) => void): void
    Exposes User Data

    Retrieve the Snapchatter's best friends in order to access details like display name, birthdate, or Bitmoji.

    Parameters

    Returns void

getCurrentUser

  • getCurrentUser(callback: (data: SnapchatUser) => void): void
    Exposes User Data

    Retrieve a SnapchatUser representing the current user.

    Parameters

    Returns void

getMyAIUser

  • getMyAIUser(callback: (data: SnapchatUser) => void): void
    Exposes User Data

    Retrieve a SnapchatUser object for MyAI which you can use to access the MyAI Bitmoji or other details.

    Parameters

    Returns void

getTypeName

getUsersInCurrentContext

  • getUsersInCurrentContext(callback: (data: SnapchatUser[]) => void): void
    Exposes User Data

    Gets the list of friends in the current context, such as 1:1 chats, 1:many chats, and group chats.

    Parameters

    Returns void

isOfType

  • isOfType(type: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

requestAltitudeFormatted

  • requestAltitudeFormatted(callback: (formattedData: string) => void): void

    Provides the user's current altitude as a localized string.

    Parameters

    • callback: (formattedData: string) => void

    Returns void

requestAltitudeInMeters

  • requestAltitudeInMeters(callback: (data: number) => void): void

    Provides the user's current altitude in meters.

    Parameters

    • callback: (data: number) => void

    Returns void

requestBirthdate

  • requestBirthdate(callback: (data: Date) => void): void
    Exposes User Data

    Provides the user's birth date as a Date object.

    Parameters

    • callback: (data: Date) => void

    Returns void

requestBirthdateFormatted

  • requestBirthdateFormatted(callback: (formattedData: string) => void): void
    Exposes User Data

    Provides the user's birth date as localized string.

    Parameters

    • callback: (formattedData: string) => void

    Returns void

requestCity

  • requestCity(callback: (data: string) => void): void
    Exposes User Data

    Provides the name of the city the user is currently located in.

    Parameters

    • callback: (data: string) => void

    Returns void

requestDisplayName

  • requestDisplayName(callback: (data: string) => void): void

    Provides the user's display name.

    Parameters

    • callback: (data: string) => void

    Returns void

requestTemperatureCelsius

  • requestTemperatureCelsius(callback: (data: number) => void): void

    Provides the user's current temperature in celsius.

    Parameters

    • callback: (data: number) => void

    Returns void

requestTemperatureFahrenheit

  • requestTemperatureFahrenheit(callback: (data: number) => void): void

    Provides the user's current temperature in fahrenheit.

    Parameters

    • callback: (data: number) => void

    Returns void

requestTemperatureFormatted

  • requestTemperatureFormatted(callback: (formattedData: string) => void): void

    Provides the user's current temperature as a localized string.

    Parameters

    • callback: (formattedData: string) => void

    Returns void

requestUsername

  • requestUsername(callback: (data: string) => void): void
    Exposes User Data

    Provides the user's username.

    Parameters

    • callback: (data: string) => void

    Returns void

requestWeatherCondition

  • requestWeatherCondition(callback: (data: WeatherCondition) => void): void

    Provides the user's current weather condition.

    Parameters

    Returns void

requestWeatherLocalized

  • requestWeatherLocalized(callback: (formattedData: string) => void): void

    Provides the user's current weather condition as a localized string.

    Parameters

    • callback: (formattedData: string) => void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
MMNEPVFCICPMFPCPTTAAATR