Z.Device

Studio

Z.Device

Description

The Z.Device object provides a number of functions for interacting with the underlying platform.

A globally accessible instance of this object is available at Z.device.

Provided by Z.Device

Constructor

Z.Device( ) Constructs a new Z.Device instance.

Enumerations

LaunchMethod The ways in which an experience can have been launched.

Functions

appData( ) Gets a string of data provided by a host app.
appIdentifier( ) Gets the identity of the app running the experience.
deepLinkId( ) Gets a unique string for the zapcode scanned to launch the experience.
gif(...) Triggers the device to take a 90 frame gif.
gifMessage( ) Gets the message that will be pre-filled in any share dialog of a gif that has been taken.
gifMessage(...) Sets the message that will be pre-filled in any share dialog of a gif that has been taken.
hasGyro( ) Gets if the device has a gyroscope.
launchMethod( ) Gets how the current experience was launched.
launchUrl(...) Displays a web view and navigates to the supplied URL.
messageHost(...) Sends a message to the app that hosts this experience.
playFullscreenVideo(...) Plays the video at the supplied URL fullscreen using the device's OS-supplied video playback functionality.
queryStringParameter( ) Returns an array of decoded string values for a given parameter from the query string passed in a deep link.
queryStringRaw( ) Returns the unmodified query string passed in a deep link.
reset( ) Closes the experience and returns the device to scanning mode.
retrieve(...) Retrieves data previously stored on the device using the store(...) function.
saveToDevice(...) Opens a dialog that saves the media file at the specified URL to the user's device.
snapshot(...) Triggers the device to take a snapshot.
snapshotMessage( ) Gets the message that will be pre-filled in any share dialog of a snapshot that has been taken.
snapshotMessage(...) Sets the message that will be pre-filled in any share dialog of a snapshot that has been taken.
snapshotToTexture(...) Takes a snapshot and places it into a DataTexture that can be used as a skin or material.
socialShare( ) Gets if social sharing options will be presented to the user when they share a snapshot or gif.
socialShare(...) Sets if social sharing options will be presented to the user when they share a snapshot or gif.
store(...) Stores the supplied object on the device such that it can be accessed during a future execution of the experience.
themeColor( ) Gets the theme color.
themeColor(...) Sets the theme color.
userLanguage( ) Gets the language and region of the user's device.
vibrate( ) Vibrates the device if it has vibration hardware.

Interfaces

SocialOptions Allows the user to set social media options along with a message for sharing.
Open in new window