# GameServerManager.getFriendsStateData(Object object)

> 基础库 2.9.4 开始支持，低版本需做[兼容处理](1003706)。

> __以 [Promise 风格](/miniprogram/dev/framework/app-service/api.md#异步-API-返回-Promise) 调用__：不支持
> 
> __[用户授权](/minigame/dev/guide/base-ability/authorize.md)__：需要 scope.WxFriendInteraction
> 
> __微信 鸿蒙 OS 版__：支持

## 功能描述

获取所有好友的在线状态及信息。该接口需要用户授权，且只在开放数据域下可用。

## 参数

### Object object

| 属性 | 类型 | 默认值 | 必填 | 说明 |
| ---- | ---- | ------ | -------- | ---- |
| success | function |  | 否 | 接口调用成功的回调函数 |
| fail | function |  | 否 | 接口调用失败的回调函数 |
| complete | function |  | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |

#### object.success 回调函数
##### 参数

###### object res


```json
[
  {
    "属性": "list",
    "类型": "Array.<Object>",
    "说明": "好友状态信息列表",
    "子项": [
      {
        "结构属性": "userState",
        "类型": "string",
        "说明": "该玩家的自定义状态信息，通过 \u0000INLINECODE_0\u0000 接口设置"
      },
      {
        "结构属性": "sysState",
        "类型": "number",
        "说明": "系统状态，0 掉线 1 在线"
      },
      {
        "结构属性": "openId",
        "类型": "string",
        "说明": "好友 openId"
      },
      {
        "结构属性": "nickName",
        "类型": "string",
        "说明": "好友昵称"
      },
      {
        "结构属性": "avatarUrl",
        "类型": "string",
        "说明": "好友头像"
      },
      {
        "结构属性": "gender",
        "类型": "number",
        "说明": "好友性别 0未设置 1男 2女"
      }
    ]
  }
]
```
