Instant Games SDK v7.1

// This function should be called after FBInstant.initializeAsync()
// resolves.
var locale = FBInstant.getLocale(); // 'en_US'

// This function should be called after FBInstant.initializeAsync()
// resolves.
var platform = FBInstant.getPlatform(); // 'IOS'

// This function should be called after FBInstant.initializeAsync()
// resolves.
var sdkVersion = FBInstant.getSDKVersion(); // '2.0'

FBInstant.initializeAsync().then(function() {
  // Many properties will be null until the initialization completes.
  // This is a good place to fetch them:
  var locale = FBInstant.getLocale(); // 'en_US'
  var platform = FBInstant.getPlatform(); // 'IOS'
  var sdkVersion = FBInstant.getSDKVersion(); // '3.0'
  var playerID = FBInstant.player.getID();
});

FBInstant.setLoadingProgress(50); // Assets are 50% loaded

// This function should be called after FBInstant.initializeAsync()
// resolves.
FBInstant.getSupportedAPIs();
// ['getLocale', 'initializeAsync', 'player.getID', 'context.getType', ...]

// This function should be called after FBInstant.initializeAsync()
// resolves.
const entryPointData = FBInstant.getEntryPointData();

// This function should be called after FBInstant.initializeAsync()
// resolves.
FBInstant.getEntryPointAsync().then(entrypoint => console.log(entrypoint));
// 'admin_message'

FBInstant.setSessionData({coinsEarned: 10, eventsSeen: ['start', ...]});

FBInstant.startGameAsync().then(function() {
  myGame.start();
});

FBInstant.inviteAsync({
  image: base64Picture,
  text: {
    default: 'X just invaded Y\'s village!',
    localizations: {
      ar_AR: 'X \u0641\u0642\u0637 \u063A\u0632\u062A ' +
        '\u0642\u0631\u064A\u0629 Y!',
      en_US: 'X just invaded Y\'s village!',
      es_LA: '\u00A1X acaba de invadir el pueblo de Y!'
    }
  },
  data: { myReplayData: '...' }
}).then(function() {
  // continue with the game.
});

FBInstant.inviteAsync({
  image: base64Picture,
  text: {
    default: 'X just invaded Y\'s village!',
    localizations: {
      ar_AR: 'X \u0641\u0642\u0637 \u063A\u0632\u062A ' +
        '\u0642\u0631\u064A\u0629!',
      en_US: 'X just invaded Y\'s village!',
      es_LA: '\u00A1X acaba de invadir el pueblo de Y!'
    }
  },
  cta: {
    default: 'Join the fight!',
    localizations: {
      ar_AR: '\u0627\u0646\u0636\u0645 \u0625\u0644\u0649' +
        '\u0627\u0644\u0642\u062A\u0627\u0644!',
      en_US: 'Join the fight!',
      es_LA: '\u00A1\u00DAnete a la pelea!'
    }
  },
  dialogTitle: {
    default: 'Enlist your friends',
    localizations: {
      ar_AR: '\u062D\u0634\u062F \u0623\u0635\u062F\u0642' +
        '\u0627\u0621\u0643',
      en_US: 'Enlist your friends',
      es_LA: 'Alistar a tus amigos'
    }
  },
  filters: ['NEW_CONTEXT_ONLY', 'EXISTING_PLAYERS_ONLY'],
  sections: [
    {sectionType: 'GROUPS', maxResults: 2},
    {sectionType: 'USERS'}
  ],
  data: { myReplayData: '...' }
}).then(function() {
  // continue with the game.
});

FBInstant.shareAsync({
  image: base64Picture,
  text: 'X is asking for your help!',
  data: { myReplayData: '...' },
  shareDestination: ['NEWSFEED', 'GROUP', 'COPY_LINK', 'MESSENGER']
  switchContext: false,
}).then(function() {
  // continue with the game.
});

FBInstant.registerScreenshotProvider(function (submitAsync) {
  submitAsync({
    image: myBase64Image,
    text: 'my awesome screenshot',
    data: { custom_field: 'my awesome data' }
  }).then(function () {
    resumeGame();
  }).catch(function (error) {
    log(error);
  });
});

FBInstant.shareLinkAsync({
  image: base64Picture,
  text: 'Come check out what Joe has built!',
  data: { customData: '...' },
}).then(function() {
  // continue with the game.
});

// This will post a custom update. When people launch the game from this
// message, those game sessions will be able to access the specified blob
// of data through FBInstant.getEntryPointData().
FBInstant.updateAsync({
  action: 'CUSTOM',
  cta: 'Join The Fight',
  image: base64Picture,
  text: {
    default: 'X just invaded Y\'s village!',
    localizations: {
      ar_AR: 'X \u0641\u0642\u0637 \u063A\u0632\u062A ' +
      '\u0642\u0631\u064A\u0629 Y!',
      en_US: 'X just invaded Y\'s village!',
      es_LA: '\u00A1X acaba de invadir el pueblo de Y!',
    }
  }
  template: 'VILLAGE_INVASION',
  data: { myReplayData: '...' },
  strategy: 'IMMEDIATE',
  notification: 'NO_PUSH',
}).then(function() {
  // closes the game after the update is posted.
  FBInstant.quit();
});

FBInstant.switchGameAsync('12345678').catch(function (e) {
  // Handle game change failure
});

FBInstant.switchGameAsync(
  '12345678',
  {referrer: 'game_switch', reward_coins: 30},
).catch(function (e) {
  // Handle game change failure
});

FBInstant.canCreateShortcutAsync()
  .then(function(canCreateShortcut) {
    if (canCreateShortcut) {
      FBInstant.createShortcutAsync()
        .then(function() {
          // Shortcut created
        })
        .catch(function() {
          // Shortcut not created
        });
    }
  });

FBInstant.canCreateShortcutAsync()
  .then(function(canCreateShortcut) {
    if (canCreateShortcut) {
      FBInstant.createShortcutAsync()
        .then(function() {
          // Shortcut created
        })
        .catch(function() {
          // Shortcut not created
        });
    }
  });

FBInstant.quit();

FBInstant.onPause(function() {
  console.log('Pause event was triggered!');
  pauseGameplay();
})

FBInstant.hideBannerAdAsync();

FBInstant.getInterstitialAdAsync(
  'my_placement_id'
).then(function(interstitial) {
  interstitial.getPlacementID(); // 'my_placement_id'
});

FBInstant.getRewardedVideoAsync(
  'my_placement_id'
).then(function(rewardedVideo) {
  rewardedVideo.getPlacementID(); // 'my_placement_id'
});

FBInstant
  .checkCanPlayerMatchAsync()
  .then(canMatch => {
    if (canMatch) {
      FBInstant.matchPlayerAsync('level1');
    }
  });

FBInstant.getLeaderboardAsync('my_awesome_leaderboard')
  .then(leaderboard => {
    console.log(leaderboard.getName()); // 'my_awesome_leaderboard'
  });

function onScore(score) {
  if (score > bestSessionScore) {
    bestSessionScore = score;
    FBInstant.postSessionScoreAsync(bestSessionScore)
      .then(() => {
        ...
      });
  }
}

FBInstant.getTournamentAsync()
  .then(function(tournament) {
     console.log(tournament.getContextID());
     console.log(tournament.getEndTime());
  });

FBInstant.performHapticFeedbackAsync();

FBInstant.getInterstitialAdAsync(
  'my_placement_id',
).then(function(interstitial) {
  return interstitial.loadAsync();
}).then(function() {
  // Ad loaded
});

var ad = null;
FBInstant.getRewardedVideoAsync(
  'my_placement_id',
).then(function(rewardedVideo) {
  ad = rewardedVideo;
  return ad.loadAsync();
}).then(function() {
  // Ad loaded
  return ad.showAsync();
}).then(function() {
  // Ad watched
});

FBInstant.getLeaderboardAsync('my_leaderboard')
  .then(function(leaderboard) {
    console.log(leaderboard.getName()); // my_leaderboard
  });

FBInstant.getLeaderboardAsync('contextual_leaderboard')
  .then(function(leaderboard) {
    console.log(leaderboard.getContextID()); // 12345678
  });

FBInstant.getLeaderboardAsync('global_leaderboard')
  .then(function(leaderboard) {
    console.log(leaderboard.getContextID()); // null
  });

FBInstant.getLeaderboardAsync('my_leaderboard')
  .then(function(leaderboard) {
    return leaderboard.getEntryCountAsync();
  })
  .then(function(count) { console.log(count); }); // 24

FBInstant.getLeaderboardAsync('my_leaderboard')
  .then(function(leaderboard) {
    return leaderboard.getPlayerEntryAsync();
  })
  .then(function(entry) {
    console.log(entry.getRank()); // 2
    console.log(entry.getScore()); // 42
    console.log(entry.getExtraData()); // '{race: "elf", level: 3}'
  });

leaderboard.setScoreAsync(9001)
  .then(function(entry) {
    console.log(entry.getScore()); // 9001
  });

leaderboard.setScoreAsync(9001)
  .then(function(entry) {
    console.log(entry.getFormattedScore()); // '90.01 meters'
  });

leaderboard.setScoreAsync(9001)
  .then(function(entry) {
    console.log(entry.getTimestamp()); // 1515806355
  });

leaderboard.setScoreAsync(9001)
  .then(function(entry) {
    console.log(entry.getRank()); // 2
  });

leaderboard.setScoreAsync(42, '{race: "elf", level: 3}');
  .then(function(entry) {
    console.log(entry.getExtraData()); // '{race: "elf", level: 3}'
  });

leaderboard.setScoreAsync(9001)
  .then(function(entry) {
    console.log(entry.getPlayer().getName()); // Sally
  });

leaderboard.setScoreAsync(9001)
  .then(function(entry) {
    console.log(entry.getPlayer().getPhoto()); // <photo_url>
  });

leaderboard.setScoreAsync(9001)
  .then(function(entry) {
    console.log(entry.getPlayer().getID()); // 12345678
  });

FBInstant.getTournamentAsync()
  .then(function(tournament) {
    console.log(tournament.getEndTime());
  });

FBInstant.getTournamentAsync()
  .then(function(tournament) {
    console.log(tournament.getTournamentType());
  });

FBInstant.getTournamentAsync()
  .then(function(tournament) {
    console.log(tournament.getTitle());
  })

FBInstant.getTournamentAsync()
  .then(function(tournament) {
    console.log(tournament.getPayload());
  })

FBInstant.community.canGetLiveStreamsAsync()
  .then(function(data) {
    console.log(data);
  });

FBInstant.community.canFollowOfficialPageAsync()
  .then(function(data) {
    console.log(data);
  });

FBInstant.community.canJoinOfficialGroupAsync()
  .then(function(data) {
    console.log(data);
  });

FBInstant.community.getLiveStreamsAsync({maxCount:1})
  .then(function(liveStreams) {
    console.log(liveStreams);
  });

FBInstant.community.followOfficialPageAsync()

FBInstant.community.joinOfficialGroupAsync()

// This function should be called after FBInstant.initializeAsync()
// resolves.
var contextID = FBInstant.context.getID();

// This function should be called after FBInstant.initializeAsync()
// resolves.
var contextType = FBInstant.context.getType();

console.log(FBInstant.context.getID());
// 1122334455
FBInstant.context
  .createAsync('12345678')
  .then(function() {
    console.log(FBInstant.context.getID());
    // 5544332211
  });

console.log(FBInstant.context.getID());
// 1122334455
FBInstant.context
  .createAsync(['12345678', '87654321'])
  .then(function() {
    console.log(FBInstant.context.getID());
    // 55443322112232
  });

console.log(FBInstant.context.getID());
// 1122334455
FBInstant.context
  .createAsync()
  .then(function() {
    console.log(FBInstant.context.getID());
    // 55443322112232
  });

var contextPlayers = FBInstant.context.getPlayersAsync()
  .then(function(players) {
    console.log(players.map(function(player) {
      return {
        id: player.getID(),
        name: player.getName(),
      }
    }));
  });
// [{id: '123456789', name: 'Luke'}, {id: '987654321', name: 'Leia'}]

FBInstant.payments.getCatalogAsync().then(function (catalog) {
  console.log(catalog); // [{productID: '12345', ...}, ...]
});

FBInstant.payments.purchaseAsync({
  productID: '12345',
  developerPayload: 'foobar',
}).then(function (purchase) {
  console.log(purchase);
  // {productID: '12345', purchaseToken: '54321', developerPayload: 'foobar', ...}
});

FBInstant.payments.getPurchasesAsync().then(function (purchases) {
  console.log(purchase);
  // [{productID: '12345', ...}, ...]
});

FBInstant.payments.consumePurchaseAsync('54321').then(function () {
  // Purchase successfully consumed!
  // Game should now provision the product to the player
});

FBInstant.payments.onReady(function () {
  console.log('Payments Ready!')
});

// This function should be called after FBInstant.initializeAsync()
// resolves.
var playerID = FBInstant.player.getID();

// This function should be called after FBInstant.initializeAsync()
// resolves.
var playerASID = FBInstant.player.getASIDAsync().then(
 asid => console.log(asid);
);

// This function should be called after FBInstant.initializeAsync()
// resolves.
var playerASID = FBInstant.player.getSignedASIDAsync()
  .then(function (result) {
    result.getASID();
  });

// This function should be called after FBInstant.initializeAsync()
// resolves.
FBInstant.player.getSignedPlayerInfoAsync('my_metadata')
  .then(function (result) {
    // The verification of the ID and signature should happen on server side.
    SendToMyServer(
      result.getPlayerID(), // same value as FBInstant.player.getID()
      result.getSignature(),
      'GAIN_COINS',
      100);
  });

// This function should be called before FBInstant.player.subscribeBotAsync()
FBInstant.player.canSubscribeBotAsync().then(
  can_subscribe => console.log(can_subscribe)
);
// 'true'

FBInstant.player.subscribeBotAsync().then(
  // Player is subscribed to the bot
).catch(function (e) {
  // Handle subscription failure
});

// This function should be called after FBInstant.initializeAsync()
// resolves.
var playerName = FBInstant.player.getName();

var playerImage = new Image();
playerImage.crossOrigin = 'anonymous';
// This function should be called after FBInstant.initializeAsync()
// resolves.
playerImage.src = FBInstant.player.getPhoto();

FBInstant.player
  .getDataAsync(['achievements', 'currentLife'])
  .then(function(data) {
     console.log('data is loaded');
     var achievements = data['achievements'];
     var currentLife = data['currentLife'];
  });

FBInstant.player
  .setDataAsync({
    achievements: ['medal1', 'medal2', 'medal3'],
    currentLife: 300,
  })
  .then(function() {
    console.log('data is set');
  });

FBInstant.player
  .setDataAsync({
    achievements: ['medal1', 'medal2', 'medal3'],
    currentLife: 300,
  })
  .then(FBInstant.player.flushDataAsync)
  .then(function() {
    console.log('Data persisted to FB!');
  });

var connectedPlayers = FBInstant.player.getConnectedPlayersAsync()
  .then(function(players) {
    console.log(players.map(function(player) {
      return {
        id: player.getID(),
        name: player.getName(),
      }
    }));
  });
// [{id: '123456789', name: 'Paul Atreides'}, {id: '987654321', name: 'Duncan Idaho'}]

FBInstant.player.getSignedPlayerInfoAsync()
  .then(function (result) {
    result.getPlayerID(); // same value as FBInstant.player.getID()
  });

FBInstant.player.getSignedPlayerInfoAsync()
  .then(function (result) {
    result.getSignature();
    // Eii6e636mz5J47sfqAYEK40jYAwoFqi3x5bxHkPG4Q4.eyJhbGdvcml0aG0iOiJITUFDLVNIQTI1NiIsImlzc3VlZF9hdCI6MTUwMDM5ODY3NSwicGxheWVyX2lkIjoiMTI0OTUyNTMwMTc1MjIwMSIsInJlcXVlc3RfcGF5bG9hZCI6Im15X2ZpcnN0X3JlcXVlc3QifQ
  });

FBInstant.player.getSignedASIDAsync()
  .then(function (result) {
    result.getASID();
  });

FBInstant.room.getCurrentMatchAsync()
  .then(function(match) {
    console.log(match.getID());
  });

FBInstant.room.getCurrentMatchAsync()
  .then(function(match) {
    console.log(match.getContextID());
  });

FBInstant.room.loadCameraEffectAsync()
  .then(function(effect) {
    effect.showAsync().then(() => console.log("Effect shown"));
  });

FBInstant.room.getCurrentMatchAsync()
  .then(function(match) {
    ...
  });

FBInstant.room.loadCameraEffectAsync({effectID: '123'})
  .then(function(effect) {
    ...
  });

FBInstant.room.clearCameraEffectAsync()
  .then(function() {
    ...
  });

FBInstant.squads.getAsync(contextID)
  .then(function(squad) {
    console.log(squad.getID());
  });

FBInstant.squads.getAsync(contextID)
  .then(function(squad) {
    console.log(squad.getName());
  });

FBInstant.squads.getAsync(contextID)
  .then(function(squad) {
    console.log(squad.getImage());
  });

FBInstant.squads.getAsync(id)
  .then(function(squad) {
    console.log(squad.getContextID());
  });

FBInstant.squads.getAsync(squadID)
  .then(function(squad) {
    squad.joinAsync().then(...)
  });

FBInstant.squads.getAsync(squadID)
  .then(function(squad) {
    squad.leaveAsync().then(...)
  });

FBInstant.squads.getAsync(squadID)
  .then(function(squad) {
    squad.addToSquadAsync().then(...)
  });

FBInstant.squads.createAsync()
  .then(function(squad) {
    ...
  });

FBInstant.squads.getAsync(squadID)
  .then(function(squad) {
    console.log(squad.getID())
  });

FBInstant.squads.getPlayerSquadsAsync()
  .then(function(squads) {
    squads.forEach(squad => console.log(squad.getID()));
  });

FBInstant.squads.canUseSquadsAsync()
  .then(function(isEligible) {
    if (isEligible) {
     FBInstant.squads.getAsync(squadID)
      .then(function(squad) {
      console.log(squad.getID())
    });
    }
  });

function onScore(score) {
  if (score > bestScore) {
    bestScore = score;
    FBInstant.tournament.postScoreAsync(bestScore)
      .then(function() {
        ...
      });
  }
}

FBInstant.tournament.shareAsync({
  score: 3,
  data: { myReplayData: '...' }
}).then(function() {
  // continue with the game.
});

FBInstant.getTournamentAsync().then((tournament) => {
   console.log(tournament.getID());
});
// 1122334455
FBInstant.tournament
  .joinAsync('1122334455')
  .then(function() {
     // Context switch completed successfully.
  });

FBInstant.tournament.getTournamentsAsync()
 .then(tournaments => {
   // tournament list
 });