Facebook Instant Games API 说明

fbinstant.d.ts for sdk v6.2

FBInstant

Instant Games SDK 的顶级命名空间.

player

包含与当前玩家相关的功能和属性

getID()

玩家的唯一标识ID。一个Facebook用户的id是不会改变的。同一个Facebook的用户，在不同的游戏里会有不用的id。注意，该方法必须在 FBInstant.initializeAsync() 调用之后使用

代码示例：

// 该方法必须在 FBInstant.initializeAsync() 调用之后使用
var playerID = FBInstant.player.getID();

返回值：string，用户的唯一ID

getSignedPlayerInfoAsync( )

获取玩家的唯一ID和签名，签名用来验证该 ID 来自 Facebook ，并且没有被篡改。该方法必须在 FBInstant.initializeAsync() 调用之后使用

参数

• requestPayload String 一个由开发者指定的信息，包含在已签名的响应消息里。

代码示例

该方法必须在 FBInstant.initializeAsync() 调用之后使用
// resolves.
FBInstant.player.getSignedPlayerInfoAsync('my_metadata')
  .then(function (result) {
    // ID和签名的验证应放在服务器端处理。
    SendToMyServer(
      result.getPlayerID(), // 和 FBInstant.player.getID() 相同
      result.getSignature(),
      'GAIN_COINS',
      100);
  });

• 抛出 INVALID_PARAM

• 抛出 NETWORK_FAILURE

• 抛出 CLIENT_REQUIRES_UPDATE

返回值： Promise<SignedPlayerInfo> 一个带有 signedplayerinfo 对象的 Promise.

canSubscribeBotAsync()

返回一个 promise，表示玩家是否可以与游戏机器人对战。

代码示例：

// 该方法必须在 FBInstant.player.subscribeBotAsync() 之前调用
FBInstant.player.canSubscribeBotAsync().then(
  can_subscribe => console.log(can_subscribe)
);

返回值： Promise<boolean> 玩家是否可以与机器人对战。开发者必须在检测 canSubscribeBotAsync() 之后再调用 subscribeBotAsync()。玩家在游戏中只会看到一次订阅机器人的对话框。

subscribeBotAsync()

请求玩家订阅游戏机器人。如果失败，API 将返回 reject,如果成功，玩家将订阅游戏机器人。

代码示例：

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

• 抛出 INVALID_PARAM

• 抛出 PENDING_REQUEST

• 抛出 CLIENT_REQUIRES_UPDATE

返回值： Promise 如果玩家成功订阅游戏机器人，将返回 resolve；如果失败或玩家选择不订阅，将返回 reject.

getName()

用户在Facebook上的的名字，使用用户的语言种类显示。注意，该方法必须在 FBInstant.initializeAsync() 调用之后使用

代码示例：

//该方法必须在 FBInstant.initializeAsync() 调用之后使用
var playerName = FBInstant.player.getName();

返回值：string，用户的名字

getPhoto()

用户头像的链接地址。头像的图片始终为正方形，尺寸最小为200x200。建议在游戏中使用的时候，先将图像缩放到所需的大小。注意，该方法必须在 FBInstant.initializeAsync() 调用之后使用

警告：由于跨域的问题，在 canvas 里使用图片会有问题。要防止此情况，请将图像的 cross-origin 属性设置为 "anonymous"

代码示例：

//该方法必须在 FBInstant.initializeAsync() 调用之后使用
var playerImage = new Image();
playerImage.crossOrigin = 'anonymous';
playerImage.src = FBInstant.player.getPhoto();

返回值：string，用户的头像的链接地址

getDataAsync()

取回当前用户在FB平台储存的数据

参数

• keys Array <String> 一个用来检索数据的key的数组

代码示例：

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

Throws INVALID_PARAM
Throws NETWORK_FAILURE
Throws CLIENT_REQUIRES_UPDATE

返回值 Promise <Object> 如果发送的Key存在，则通过Promise 返回储存的数据对象.

setDataAsync()

把当前用户的数据储存在FB平台上。每个用户可以在每个游戏里储存1MB的数据。代码示例：

参数

• data Object 需要储存的数据，包含key-value的数据对象。对象只能包含可以序列化的值，任何不可序列化的值都会导致储存失败。

代码示例：

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

Throws INVALID_PARAM
Throws NETWORK_FAILURE
Throws PENDING_REQUEST
Throws CLIENT_REQUIRES_UPDATE

返回值 Promise 当数据提交了以后会返回一个 promise。注意：这个promise 并不意味着这个数据已经被成功保存。它只是验证了数据的有效性，并且随后会被保存。可以保证的是，在调用 player.getDataAsync 方法时，这些设定的数据会生效。

flushDataAsync()

将用户的数据立刻更新到云存储。这个方法的调用成本较高，应该主要用于关键的更改。非关键的更改应该依赖于平台来将它们储存到后台。注意: 当该方法未完成时，调用 player.setDataAsync 这个方法会被拒绝.

代码示例：

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

Throws INVALID_PARAM
Throws NETWORK_FAILURE
Throws PENDING_REQUEST
Throws CLIENT_REQUIRES_UPDATE

返回值 Promise 数据储存成功会返回一个promise，如果保存失败则返回拒绝

getStatsAsync()

从云存储中获取当前玩家数据。

参数

• keys Array <String>？ 一个用来检索状态数据的key的数组(可选)。如果没有参数，将返回所有状态

代码示例：

FBInstant.player
  .getStatsAsync(['level', 'zombiesSlain'])
  .then(function(stats) {
    console.log('stats are loaded');
    var level = stats['level'];
    var zombiesSlain = stats['zombiesSlain'];
  });

Throws INVALID_PARAM
Throws NETWORK_FAILURE
Throws CLIENT_UNSUPPORTED_OPERATION

返回值： Promise<Object> 输入的数组作为键值的对象.

setStatsAsync()

把当前玩家数据储存到云空间里。

参数

• stats Object 一个包含了key-value的对象，将被持久化的存储到云端，它可以在各种方法中使用。该对象只能使用数字作为value，任何非数值类型都会导致存储失败。

代码示例：

FBInstant.player
  .setStatsAsync({

10000
    level: 5,
    zombiesSlain: 27,
  })
  .then(function() {
    console.log('data is set');
  });

Throws INVALID_PARAM
Throws NETWORK_FAILURE
Throws PENDING_REQUEST
Throws CLIENT_UNSUPPORTED_OPERATION

返回值： Promise 当数据提交了以后会返回一个 promise。注意：这个promise 并不意味着这个数据已经被成功保存。它只是验证了数据的有效性，并且随后会被保存。可以保证的是，在调用 player.getStatsAsync 方法时，这些设定的数据会生效。

incrementStatsAsync()

把当前玩家数据增量更新储存到云空间里。

参数

• increments Object 一个包含了key-value的对象，它表明了哪个 stat 的值会增量更新。该对象只能使用数字作为value，任何非数值类型都会导致存储失败。

代码示例：

FBInstant.player
  .incrementStatsAsync({
    level: 1,
    zombiesSlain: 17,
    rank: -1,
  })
 .then(function(stats) {
    console.log('increments have been made! New values');
    var level = stats['level'];
    var zombiesSlain = stats['zombiesSlain'];
  });

Throws INVALID_PARAM
Throws NETWORK_FAILURE
Throws PENDING_REQUEST
Throws CLIENT_UNSUPPORTED_OPERATION

返回值： Promise 当数据提交了以后会返回一个 promise。注意：这个promise 并不意味着这个数据已经被成功保存。它只是验证了数据的有效性，并且随后会被保存。可以保证的是，在调用 player.getStatsAsync 方法时，这些设定的数据会生效。

getConnectedPlayersAsync()

获取和当前玩家有关联的玩家列表信息（即好友列表）。

代码示例：

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'}]

Throws NETWORK_FAILURE
Throws CLIENT_REQUIRES_UPDATE

返回值 Promise <Object<ConnectedPlayer>返回一个promise，包含了关联用户对象的数据

##context 包含当前游戏环境的一些方法和属性

getID()

当前游戏来源的唯一id。它代表了当前游戏是在哪玩的（例如：是在 messenger 的对话里还是 facebook 的网页里）。如果是在独立页面玩的游戏，这个id值为 null。只有在 FBInstant.startGameAsync 方法被调用后，这个结果才能保证是正确的。

代码示例：

//该方法必须放在 FBInstant.startGameAsync() 的回调里。
var contextID = FBInstant.context.getID();

返回值 string，当前游戏环境的id。

getType()

当前游戏的环境类型。

代码示例：

//该方法必须放在 FBInstant.startGameAsync() 的回调里。
var contextType = FBInstant.context.getType();

返回值 ("POST" | "THREAD" | "GROUP" | "SOLO") 当前游戏环境的类型。

isSizeBetween()

用这个方法来判断当前游戏环境中游戏参与者的数量是否介于指定的最小值和最大值之间。如果其中一个边界为空，则只对另一个边界进行检查。在当前游戏中第一次调用后，以后永远返回这个结果，不管参数如何改变。直到游戏环境发生改变，才会重置查询结果。

参数 • minSize number 要查询的环境值的最小值。 • maxSize number 要查询的环境值的最大值。

代码示例：

console.log(FBInstant.context.isSizeBetween(3, 5)); //(Context size = 4)
// {answer: true, minSize: 3, maxSize: 5}

console.log(FBInstant.context.isSizeBetween(5, 7)); //(Context size = 4)
// {answer: false, minSize: 5, maxSize: 7}

console.log(FBInstant.context.isSizeBetween(2, 10));// (Context size = 3)
// {answer: true, minSize: 2, maxSize: 10}
console.log(FBInstant.context.isSizeBetween(4, 8));// (Still in same context)
// {answer: true, minSize: 2, maxSize: 10}

console.log(FBInstant.context.isSizeBetween(3, null)); //(Context size = 4)
// {answer: true, minSize: 3, maxSize: null}

console.log(FBInstant.context.isSizeBetween(null, 3)); (Context size = 4)
// {answer: false, minSize: null, maxSize: 3}

console.log(FBInstant.context.isSizeBetween("test", 5)); (Context size = 4)
// null

console.log(FBInstant.context.isSizeBetween(0, 100)); (Context size = null)
// null

返回值 ContextSizeResponse。

switchAsync()

请求切换到指定的游戏环境。如果玩家没有进入该环境的权限，或者玩家没有提供进入游戏的许可，该方法都会被拒绝。如果成功切换到指定游戏环境，将会返回一个 promise.

参数

• id string 想要进入的环境ID

代码示例：

console.log(FBInstant.context.getID());
// 1122334455
FBInstant.context
  .switchAsync('1234567890')
  .then(function() {
    console.log(FBInstant.context.getID());
    // 1234567890
  });

Throws INVALID_PARAM
Throws SAME_CONTEXT
Throws NETWORK_FAILURE
Throws USER_INPUT
Throws PENDING_REQUEST
Throws CLIENT_REQUIRES_UPDATE

返回值 Promise 当游戏切换到指定环境，返回一个 promise，失败会被拒绝。

chooseAsync()

为玩家打开一个游戏环境选择列表。如果玩家选择了一个可用的环境，客户端将尝试切到那个环境，如果成功，返回 resolve。如果玩家退出菜单，或者客户端未能切换到新环境，返回 reject.

参数

• options Object? 提供可选择的环境对象。

• options.filters Array< ContextFilter>? 设置一组应用于环境对象的过滤器.

• options.maxSize number? 理想情况下，环境对象的最大值

• options.minSize number? 理想情况下，环境对象的最小值

代码示例：

console.log(FBInstant.context.getID());
// 1122334455
FBInstant.context
  .chooseAsync()
  .then(function() {
    console.log(FBInstant.context.getID());
    // 1234567890
  });

console.log(FBInstant.context.getID());
// 1122334455
FBInstant.context
  .chooseAsync({
    filters: ['NEW_CONTEXT_ONLY'],
    minSize: 3,
  })
  .then(function() {
    console.log(FBInstant.context.getID());
    // 1234567890
  });

Throws INVALID_PARAM
Throws SAME_CONTEXT
Throws NETWORK_FAILURE
Throws USER_INPUT
Throws PENDING_REQUEST
Throws CLIENT_REQUIRES_UPDATE

返回值 Promise 当游戏切换到指定环境，返回一个 promise，失败会返回reject(例如，用户取消了对话框)

createAsync()

在当前玩家和指定玩家之间，尝试创建或切换一个环境。如果指定玩家不能玩这个游戏，或者玩家决绝进入新环境，则返回 recject。如果成功切换到新游戏的环境时，则返回 resolve。

参数

• playerID string 用户的 ID

代码示例：

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

Throws INVALID_PARAM
Throws SAME_CONTEXT
Throws NETWORK_FAILURE
Throws USER_INPUT
Throws PENDING_REQUEST
Throws CLIENT_REQUIRES_UPDATE

返回值 Promise 当游戏成功切换到指定环境，返回一个 promise 的 resolve，失败会返回reject

getPlayersAsync()

获取当前环境中正在玩游戏的玩家列表(在过去 90 天内玩过游戏的用户)，它可能包含当前玩家的信息。

代码示例：

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'}]

Throws NETWORK_FAILURE
Throws CLIENT_REQUIRES_UPDATE
Throws INVALID_OPERATION

返回 Promise <Array<ContextPlayer>>

payments

【内测】包含与支付和购买游戏产品相关的功能和属性。

getCatalogAsync()

获取游戏的产品目录。

代码示例：

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

Throws CLIENT_UNSUPPORTED_OPERATION
Throws PAYMENTS_NOT_INITIALIZED
Throws NETWORK_FAILURE

返回值 Promise，注册到游戏的一组产品

purchaseAsync()

开始特定产品的购买流程。如果在FBInstant.startGameAsync()解析之前调用，将返回 reject。

参数

• playerID purchaseConfig 购买的配置文件

代码示例：

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

Throws CLIENT_UNSUPPORTED_OPERATION
Throws PAYMENTS_NOT_INITIALIZED
Throws INVALID_PARAM
Throws NETWORK_FAILURE
Throws INVALID_OPERATION

返回值 Promise，当玩家成功购买产品时返回 resolve。失败返回 reject。

getPurchasesAsync()

获取玩家未消费的所有购买商品。最佳做法是，游戏在客户端表明已准备好执行支付相关操作时，立即获取当前玩家的购买商品。游戏随后可处理和消费正在等待被消费的任何购买商品。

代码示例：

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

Throws CLIENT_UNSUPPORTED_OPERATION
Throws PAYMENTS_NOT_INITIALIZED
Throws NETWORK_FAILURE

返回值 Promise，玩家为游戏购买的一组商品。

consumePurchaseAsync()

消费当前玩家拥有的特定购买商品。在为玩家配置商品效果之前，游戏应先请求消费已购买的商品。购买的商品成功消费后，游戏应立即向玩家呈现购买商品的效果。

参数

• purchaseToken string 要使用的购买商品的购买口令。

代码示例：

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

Throws CLIENT_UNSUPPORTED_OPERATION
Throws PAYMENTS_NOT_INITIALIZED
Throws INVALID_PARAM
Throws NETWORK_FAILURE

返回值 Promise，此 promise 在成功消费已购买的商品时被解析。

onReady()

设置一个回调，在支付操作可进行时触发。

参数

• callback Function 当支付可进行时执行的回调函数。

代码示例：

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

返回值 void

getLocale()

获取用户的语言设置。例如 zh_CN、 en_US 全部的地域信息数据，请看此链接 https://www.facebook.com/translations/FacebookLocales.xml 。使用这个值用来确定游戏中应该显示那种语言。该方法必须在 FBInstant.initializeAsync() 调用之后使用

代码示例：

// 该方法必须在 FBInstant.initializeAsync() 调用之后使用
var locale = FBInstant.getLocale(); // 'en_US'

返回值 string，当前地域信息。

getPlatform()

当前游戏运行在哪个平台。该方法必须在 FBInstant.initializeAsync() 调用之后使用

代码示例：

该方法必须在 FBInstant.initializeAsync() 调用之后使用
var platform = FBInstant.getPlatform(); // 'IOS'

返回值 Platform?，当前游戏运行的平台("IOS" | "ANDROID" | "WEB" | "MOBILE_WEB")

getSDKVersion()

获取SDK的版本号,用字符串来表示。

代码示例：

var sdkVersion = FBInstant.getSDKVersion(); // '4.1'

返回值 string，SDK 的版本号。

initializeAsync()

初始化SDK，应当在所有其他的API使用前调用。代码示例：

FBInstant.initializeAsync().then(function() {
  // 在初始化完成之前，下面这些属性都是无法得到的。必须要放在这个回调方法里。
  var locale = FBInstant.getLocale(); // 'en_US'
  var platform = FBInstant.getPlatform(); // 'IOS'
  var sdkVersion = FBInstant.getSDKVersion(); // '4.1'
  var playerID = FBInstant.player.getID();
});

Throws INVALID_OPERATION

返回值 Promise 当sdk 初始化完成后会返回 promise

setLoadingProgress()

通知平台游戏初始化资源加载的进度

参数

• percentage number 0到100之间的数字

代码示例：

FBInstant.setLoadingProgress(50); // 50%的资源被加载了

返回值 void

getSupportedAPIs()

提供当前客户端支持的 API 函数列表。

代码示例：该方法必须在 FBInstant.initializeAsync() 调用之后使用

//该方法必须在 FBInstant.initializeAsync() 调用之后使用
FBInstant.getSupportedAPIs();
// ['getLocale', 'initializeAsync', 'player.getID', 'context.getType', ...]

返回值 Array<string> 返回客户端支持的 API 函数列表

getEntryPointData()

返回与游戏启动的入口点相关的数据对象。

对象的内容是开发人员定义的，并且可以在不同平台的入口点触发。在老的移动客户端上会返回 null。如果特定的入口点没有数据时，也会返回 null。

代码示例：

//该方法必须在 FBInstant.initializeAsync() 调用之后使用
const entryPointData = FBInstant.getEntryPointData();

返回值 Object 与当前入口点相关的数据。

getEntryPointAsync()

返回与游戏启动的入口点相关的数据对象。

代码示例：

//该方法必须在 FBInstant.initializeAsync() 调用之后使用
FBInstant.getEntryPointAsync();
// 'admin_message'

返回值： String 用户从哪个入口进入的游戏

setSessionData()

为当前环境设置游戏的数据。每当游戏想要更新当前会话的数据时，可以调用该方法。参数

• sessionData Object 一个任意的数据对象，必须小于1000个字符

代码示例：

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

返回值 void

startGameAsync()

这表明游戏已经加载完资源，可以开始玩了。当返回 promise 的 resolve 时，环境信息将会更新。

代码示例：

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

Throws INVALID_PARAM
Throws CLIENT_REQUIRES_UPDATE

返回值 Promise 当游戏应当开始玩的时候会返回 promise

shareAsync()

这将启动一个对话框，让用户共享指定的内容，可能是一个 Messenger 里的消息，或者是用户时间线上的一个帖子。一个blob数据可以附加在分享上，当游戏通过分享启动时，可以通过 FBInstant.getEntryPointData() 方法获取。这个数据必须少于1000个字符。用户可以选择取消分享，或者关闭对话框，但不论用户是否真的分享了内容，都会返回 promise 的 resolve。

参数

• payload SharePayload 要分享的内容，请看示例代码

代码示例：

FBInstant.shareAsync({
  intent: 'REQUEST',
  image: base64Picture,
  text: 'X is asking for your help!',
  data: { myReplayData: '...' },
}).then(function() {
  // 继续游戏
});

抛出 INVALID_PARAM
抛出 NETWORK_FAILURE
抛出 PENDING_REQUEST
抛出 CLIENT_REQUIRES_UPDATE
抛出 INVALID_OPERATION

返回值 Promise 不管分享成功或失败，都会返回 promise 的 resolve

updateAsync()

通知Facebook在游戏中发生的更新。这将暂时把控制权交给Facebook，而Facebook将决定根据更新的内容来做什么。当Facebook将控制权归还给游戏时，将返回 promise 的 resolve/reject.

参数

• payload CustomUpdatePayload | LeaderboardUpdatePayload 要更新的内容

代码示例：

//这将发送一个自定义更新。如果游戏是运行在一个 messenger 的对话里，
//它将发送一条带有图文的消息到指定的对话里。
//如果其他用户通过这条消息启动了游戏，
//这些游戏会话将可以通过 FBInstant.getEntryPointData() 方法获取附加的 blob 数据。 

FBInstant.updateAsync({
  action: 'CUSTOM',
  cta: 'Join The Fight',
  template:'join_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() {
  //当消息发送后，关闭游戏
  FBInstant.quit();
});

抛出 INVALID_PARAM
抛出 PENDING_REQUEST
抛出 INVALID_OPERATION

返回值 Promise 当Facebook将控制权归还给游戏时返回 promise

switchGameAsync()

请求客户端切换到另一个小游戏。切换失败时，API 将拒绝；成功时，客户端将加载新游戏。

参数

• appID **string ** 要切换到的小游戏相应的应用编号。应用必须为小游戏，且必须和当前游戏属于同一商家所有。要将不同游戏关联到相同商家，您可使用商务管理平台：https://developers.facebook.com/docs/apps/business-manager#update-business

• data string 可选的附加数据。会被设置为要切换到的游戏的入口点数据。转变为字符串时，必须小于或等于 1000 个字符。

代码示例：

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

抛出 USER_INPUT
抛出 INVALID_PARAM
抛出 PENDING_REQUEST
抛出 CLIENT_REQUIRES_UPDATE

返回值 Promise 当Facebook将控制权归还给游戏时返回 promise

canCreateShortcutAsync()

用户是否有资格创建快捷方式。如果 createShortcutAsync 已经被调用了或者用户没有资格创建快捷方式，返回 false.

代码示例：

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

抛出 PENDING_REQUEST
抛出 CLIENT_REQUIRES_UPDATE
抛出 INVALID_OPERATION

返回值 Promise 如果游戏允许玩家创建快捷方式，返回 true，否则返回 false

createShortcutAsync()

如果用户有资格，提示用户创建游戏的快捷方式。每次会话只能调用一次。

代码示例：

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

抛出 USER_INPUT
抛出 PENDING_REQUEST
抛出 CLIENT_REQUIRES_UPDATE
抛出 INVALID_OPERATION

返回值 Promise

quit()

退出游戏

代码示例：

FBInstant.quit();

返回值 void

logEvent()

使用 Facebook 的分析系统来记录一个应用的事件消息，更多细节请参见： https://developers.facebook.com/docs/javascript/reference/v2.8#app_events

参数

• eventName string 事件的名称。必须是2到40个字符，只能包含'_', '-', ' '和字母数字的字符。

• valueToSum number 一个可选的数字，FB分析可以计算它。

• parameters Object 一个可选的对象，它可以包含多达25个 key-value，以记录事件。key 必须是2-40个字符，只能包含'_', '-', ' '和字母数字的字符。 Value 必须少于100个字符。

代码示例：

var logged = FBInstant.logEvent(
  'my_custom_event',
  42,
  {custom_property: 'custom_value'},
);

返回值 APIError 如果事件记录失败，返回错误信息，否则返回 null.

onPause()

设置一个暂停事件触发时调用的方法。

参数

• func Function 当暂停事件触发时调用的方法。

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

返回值 void

getInterstitialAdAsync()

尝试创建插屏广告的实例。此实例可在之后预载和显示。

参数

• placementID String 在 Audience Network 设置的位置ID。

代码示例：

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

抛出 ADS_TOO_MANY_INSTANCES
抛出 CLIENT_UNSUPPORTED_OPERATION

返回值： Promise 成功了返回 resolves，失败了返回 reject

getRewardedVideoAsync()

尝试创建一个激励视频广告的实例。此实例可在之后预载和显示。

参数

• placementID string 在 Audience Network 设置的位置ID。

代码示例：

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

抛出 ADS_TOO_MANY_INSTANCES
抛出 CLIENT_UNSUPPORTED_OPERATION

返回值： Promise 成功了返回 resolves，失败了返回 reject

matchPlayerAsync()

[封闭公测] 尝试将当前玩家与等待他人加入游戏的其他玩家进行匹配。如果匹配成功，将为匹配的玩家创建一个新的 Messenger 群聊，且玩家的游戏环境将切换到该群聊。

参数

matchTag string 玩家的可选额外信息，可用于将玩家加到具有相似玩家的群聊中。具有完全相同标签的玩家才会加入同一群聊。标签只能包含字母、数字和下划线，且长度不能超过 100 个字符。
switchContextWhenMatched boolean 可选的额外参数，指定当找到匹配时，是否将玩家立即切换到新环境。默认设置为 false，亦即玩家在匹配成功后，需要明确点击玩游戏按钮才会切换到新环境。

代码示例：

FBInstant
  .matchPlayerAsync('level1')
  .then(function() {
    console.log(FBInstant.context.getID());
    // 12345
  });

FBInstant
  .matchPlayerAsync()
  .then(function() {
    console.log(FBInstant.context.getID());
    // 3456
  });

FBInstant
  .matchPlayerAsync(null, true)
  .then(function() {
    console.log(FBInstant.context.getID());
    // 3456
  });

抛出 INVALID_PARAM
抛出 NETWORK_FAILURE
抛出 USER_INPUT
抛出 PENDING_REQUEST
抛出 CLIENT_UNSUPPORTED_OPERATION
抛出 INVALID_OPERATION

返回值： Promise 当玩家已加入群聊并切换到群聊环境时，此 promise 被解析。

checkCanPlayerMatchAsync()

[封闭公测] 检查当前玩家是否符合 matchPlayerAsync API 的条件。

代码示例：

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

抛出 NETWORK_FAILURE
抛出 CLIENT_UNSUPPORTED_OPERATION

返回值： Promise 当玩家符合与其他玩家匹配的条件时，此 promise 被解析为 true，否则解析为 false。

getLeaderboardAsync()

获取这款小游戏中的特有排行榜。

参数

• name string 小游戏的每个排行榜必须具有唯一的名称

代码示例

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

抛出 LEADERBOARD_NOT_FOUND
抛出 NETWORK_FAILURE
抛出 CLIENT_UNSUPPORTED_OPERATION
抛出 INVALID_OPERATION
抛出 INVALID_PARAM

返回值： Promise 此 promise 在获得匹配的排行榜时被解析，在未找到匹配时被拒绝。

Name		Name	Last commit message	Last commit date
Latest commit History 23 Commits
README.md		README.md
fbinstant.d.ts		fbinstant.d.ts
fbinstant.js		fbinstant.js

loper-gh/FBInstantGameDTS

Folders and files

Latest commit

History

Repository files navigation

Facebook Instant Games API 说明

FBInstant

player

getID()

getSignedPlayerInfoAsync( )

canSubscribeBotAsync()

subscribeBotAsync()

getName()

getPhoto()

getDataAsync()

setDataAsync()

flushDataAsync()

getStatsAsync()

setStatsAsync()

incrementStatsAsync()

getConnectedPlayersAsync()

getID()

getType()

isSizeBetween()

switchAsync()

chooseAsync()

createAsync()

getPlayersAsync()

payments

getCatalogAsync()

purchaseAsync()

getPurchasesAsync()

consumePurchaseAsync()

onReady()

getLocale()

getPlatform()

getSDKVersion()

initializeAsync()

setLoadingProgress()

getSupportedAPIs()

getEntryPointData()

getEntryPointAsync()

setSessionData()

startGameAsync()

shareAsync()

updateAsync()

switchGameAsync()

canCreateShortcutAsync()

createShortcutAsync()

quit()

logEvent()

onPause()

getInterstitialAdAsync()

getRewardedVideoAsync()

matchPlayerAsync()

checkCanPlayerMatchAsync()

getLeaderboardAsync()

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Packages