capacitor-kakao-plugin/dist/docs.json

capacitor kakao plugin supports Capacitor 6

{
  "api": {
    "name": "CapacitorKakaoPlugin",
    "slug": "capacitorkakaoplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "initializeKakao",
        "signature": "(options: { appKey: string; webKey: string; }) => Promise<{ status: KakaoOAuthTokenStatus; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appKey: string; webKey: string; }"
          }
        ],
        "returns": "Promise<{ status: KakaoOAuthTokenStatus; }>",
        "tags": [],
        "docs": "initialize only for web.",
        "complexTypes": [
          "KakaoOAuthTokenStatus"
        ],
        "slug": "initializekakao"
      },
      {
        "name": "kakaoWebLogin",
        "signature": "(options: { redirectUri: string; scopes?: string[]; }) => void",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ redirectUri: string; scopes?: string[] | undefined; }"
          }
        ],
        "returns": "void",
        "tags": [],
        "docs": "kakao web login",
        "complexTypes": [],
        "slug": "kakaoweblogin"
      },
      {
        "name": "kakaoLogin",
        "signature": "() => Promise<KakaoToken>",
        "parameters": [],
        "returns": "Promise<KakaoToken>",
        "tags": [],
        "docs": "kakao login",
        "complexTypes": [
          "KakaoToken"
        ],
        "slug": "kakaologin"
      },
      {
        "name": "kakaoLogout",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "kakao logout",
        "complexTypes": [],
        "slug": "kakaologout"
      },
      {
        "name": "kakaoUnlink",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "disconnect link with app",
        "complexTypes": [],
        "slug": "kakaounlink"
      },
      {
        "name": "shareDefault",
        "signature": "(options: { title: string; description: string; imageUrl: string; imageLinkUrl: string; buttonTitle: string; imageWidth?: number; imageHeight?: number; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ title: string; description: string; imageUrl: string; imageLinkUrl: string; buttonTitle: string; imageWidth?: number | undefined; imageHeight?: number | undefined; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "send kakao link (only default kakao link)",
        "complexTypes": [],
        "slug": "sharedefault"
      },
      {
        "name": "getUserInfo",
        "signature": "() => Promise<{ value: any; }>",
        "parameters": [],
        "returns": "Promise<{ value: any; }>",
        "tags": [],
        "docs": "get kakao user info",
        "complexTypes": [],
        "slug": "getuserinfo"
      },
      {
        "name": "getFriendList",
        "signature": "(options?: KakaoFriendOption | undefined) => Promise<{ value: any; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "KakaoFriendOption | undefined"
          }
        ],
        "returns": "Promise<{ value: any; }>",
        "tags": [],
        "docs": "get kakao friend list data",
        "complexTypes": [
          "KakaoFriendOption"
        ],
        "slug": "getfriendlist"
      },
      {
        "name": "loginWithNewScopes",
        "signature": "(scopes?: string[] | undefined) => Promise<void>",
        "parameters": [
          {
            "name": "scopes",
            "docs": "",
            "type": "string[] | undefined"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "get additional scopes",
        "complexTypes": [],
        "slug": "loginwithnewscopes"
      },
      {
        "name": "getUserScopes",
        "signature": "() => Promise<{ value: KakaoScope[]; }>",
        "parameters": [],
        "returns": "Promise<{ value: KakaoScope[]; }>",
        "tags": [],
        "docs": "get user agreed scopes",
        "complexTypes": [
          "KakaoScope"
        ],
        "slug": "getuserscopes"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "KakaoToken",
      "slug": "kakaotoken",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "accessToken",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "refreshToken",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "KakaoFriendOption",
      "slug": "kakaofriendoption",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "offset",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "limit",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "order",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "'asc' | 'desc' | undefined"
        }
      ]
    },
    {
      "name": "KakaoScope",
      "slug": "kakaoscope",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "agreed",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "boolean"
        },
        {
          "name": "displayName",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "id",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "revocable",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "boolean"
        },
        {
          "name": "type",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "using",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "boolean"
        }
      ]
    }
  ],
  "enums": [
    {
      "name": "KakaoOAuthTokenStatus",
      "slug": "kakaooauthtokenstatus",
      "members": [
        {
          "name": "LOGIN_NEEDED",
          "value": "'LOGIN_NEEDED'",
          "tags": [],
          "docs": ""
        },
        {
          "name": "ERROR",
          "value": "'ERROR'",
          "tags": [],
          "docs": ""
        },
        {
          "name": "SUCCEED",
          "value": "'SUCCEED'",
          "tags": [],
          "docs": ""
        }
      ]
    }
  ],
  "typeAliases": [],
  "pluginConfigs": []
}