Packagecom.myflashlab.air.extensions.googleGames
Classpublic class SnapshotMetadata
InheritanceSnapshotMetadata Inheritance Object

Data interface for the metadata of a saved game.



Public Properties
 PropertyDefined By
  coverImageAspectRatio : Number
[read-only] Retrieves the aspect ratio of the cover image for this snapshot, if any.
SnapshotMetadata
  description : String
[read-only] Retrieves the description of this snapshot.
SnapshotMetadata
  deviceName : String
[read-only] Retrieves the name of the device that wrote this snapshot, if known.
SnapshotMetadata
  gameMetadata : Game
[read-only] Retrieves the game associated with this snapshot.
SnapshotMetadata
  hasChangePending : Boolean
[read-only] Indicates whether or not this snapshot has any changes pending that have not been uploaded to the server.
SnapshotMetadata
  lastModifiedTimestamp : Number
[read-only] Retrieves the last time this snapshot was modified, in millis since epoch.
SnapshotMetadata
  owner : Player
[read-only] Retrieves the player that owns this snapshot.
SnapshotMetadata
  playedTime : Number
[read-only] Retrieves the played time of this snapshot in milliseconds.
SnapshotMetadata
  progressValue : Number
[read-only] Retrieves the progress value for this snapshot.
SnapshotMetadata
  snapshotId : String
[read-only] Retrieves the ID of this snapshot.
SnapshotMetadata
  uniqueName : String
[read-only] Unique identifier of this snapshot.
SnapshotMetadata
Public Methods
 MethodDefined By
  
loadcoverImage($forceReload:Boolean, $callback:Function):void
SnapshotMetadata
Property Detail
coverImageAspectRatioproperty
coverImageAspectRatio:Number  [read-only]

Retrieves the aspect ratio of the cover image for this snapshot, if any. This is the ratio of width to height, so a value > 1.0f indicates a landscape image while a value < 1.0f indicates a portrait image. If the snapshot has no cover image, this will return 0.0f.


Implementation
    public function get coverImageAspectRatio():Number
descriptionproperty 
description:String  [read-only]

Retrieves the description of this snapshot.


Implementation
    public function get description():String
deviceNameproperty 
deviceName:String  [read-only]

Retrieves the name of the device that wrote this snapshot, if known.


Implementation
    public function get deviceName():String
gameMetadataproperty 
gameMetadata:Game  [read-only]

Retrieves the game associated with this snapshot.


Implementation
    public function get gameMetadata():Game
hasChangePendingproperty 
hasChangePending:Boolean  [read-only]

Indicates whether or not this snapshot has any changes pending that have not been uploaded to the server. Once all changes have been flushed to the server, this will return false.


Implementation
    public function get hasChangePending():Boolean
lastModifiedTimestampproperty 
lastModifiedTimestamp:Number  [read-only]

Retrieves the last time this snapshot was modified, in millis since epoch.


Implementation
    public function get lastModifiedTimestamp():Number
ownerproperty 
owner:Player  [read-only]

Retrieves the player that owns this snapshot.


Implementation
    public function get owner():Player
playedTimeproperty 
playedTime:Number  [read-only]

Retrieves the played time of this snapshot in milliseconds.


Implementation
    public function get playedTime():Number
progressValueproperty 
progressValue:Number  [read-only]

Retrieves the progress value for this snapshot.


Implementation
    public function get progressValue():Number
snapshotIdproperty 
snapshotId:String  [read-only]

Retrieves the ID of this snapshot.


Implementation
    public function get snapshotId():String
uniqueNameproperty 
uniqueName:String  [read-only]

Unique identifier of this snapshot. This name should be unique within the scope of the application.


Implementation
    public function get uniqueName():String
Method Detail
loadcoverImage()method
public function loadcoverImage($forceReload:Boolean, $callback:Function):void

Parameters

$forceReload:Boolean
 
$callback:Function — expects one param as File object to the image file.