EOS API Interface List

List of all interfaces in the EOS API

Achievements Interface

The following EOS_Achievements_* functions allow you to query existing achievement definitions that have been defined for your application. You can also query achievement progress data for users. In addition, you can also unlock one or more achievements directly. You can also receive notifications when achievements are unlocked.

When writing C code that uses the Achievements Interface, include eos_achievements.h.

You can delve deeper into the Achievements Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Achievements Interface](Interfaces/Achievements) documentation page.

AntiCheatClient Interface

When writing C code that uses the AntiCheatClient Interface, include eos_anticheatclient.h.

You can delve deeper into the AntiCheatClient Interface API for a complete technical reference, or receive guidance and usage instructions from the main [AntiCheatClient Interface](Interfaces/AntiCheatClient) documentation page.

AntiCheatServer Interface

When writing C code that uses the AntiCheatServer Interface, include eos_anticheatserver.h.

You can delve deeper into the AntiCheatServer Interface API for a complete technical reference, or receive guidance and usage instructions from the main [AntiCheatServer Interface](Interfaces/AntiCheatServer) documentation page.

Auth Interface

The Auth Interface is used to manage local user permissions and access to backend services through the verification of various forms of credentials. All Auth Interface calls take a handle of type EOS_HAuth as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetAuthInterface function.

When writing C code that uses the Auth Interface, include eos_auth.h.

You can delve deeper into the Auth Interface API for a complete technical reference, or receive guidance and usage instructions from the main Auth Interface documentation page.

Connect Interface

The Connect Interface is used to manage local user permissions and access to backend services through the verification of various forms of credentials. It creates an association between third party providers and an internal mapping that allows Epic Online Services to represent a user agnostically. All Connect Interface calls take a handle of type EOS_HConnect as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetConnectInterface function.

When writing C code that uses the Connect Interface, include eos_connect.h.

You can delve deeper into the Connect Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Connect Interface](Interfaces/Connect) documentation page.

Ecom Interface

The Ecom Interface exposes all catalog, purchasing, and ownership entitlement features available with the Epic Games store All Ecom Interface calls take a handle of type EOS_HEcom as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetEcomInterface function.

When writing C code that uses the Ecom Interface, include eos_ecom.h.

You can delve deeper into the Ecom Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Ecom Interface](Interfaces/Ecom) documentation page.

Friends Interface

The Friends Interface is used to manage a user's friends list, by interacting with the backend services, and to retrieve the cached list of friends and pending invitations. All Friends Interface calls take a handle of type EOS_HFriends as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetFriendsInterface function.

When writing C code that uses the Friends Interface, include eos_friends.h.

You can delve deeper into the Friends Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Friends Interface](Interfaces/Friends) documentation page.

KWS Interface

This interface is not available for general access at this time. The KWS Interface exists as an integration for age gating functionality provided by Kids Web Services from SuperAwesome, using the EOS Connect interface. All KWS Interface calls take a handle of type EOS_HKWS as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetKWSInterface function.

When writing C code that uses the KWS Interface, include eos_kws.h.

You can delve deeper into the KWS Interface API for a complete technical reference, or receive guidance and usage instructions from the main [KWS Interface](Interfaces/KWS) documentation page.

Leaderboards Interface

The following EOS_Leaderboards_* functions allow you to query existing leaderboard definitions that have been defined for your application. You can retrieve a list of scores for the top users for each Leaderboard. You can also query scores for one or more users.

When writing C code that uses the Leaderboards Interface, include eos_leaderboards.h.

You can delve deeper into the Leaderboards Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Leaderboards Interface](Interfaces/Leaderboards) documentation page.

Lobby Interface

The Lobby Interface is used to manage lobbies that provide a persistent connection between users and notifications of data sharing/updates. Lobbies may also be found by advertising and searching with the backend service. All Lobby Interface calls take a handle of type EOS_HLobby as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetLobbyInterface function.

When writing C code that uses the Lobby Interface, include eos_lobby.h.

You can delve deeper into the Lobby Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Lobby Interface](Interfaces/Lobby) documentation page.

Metrics Interface

The Metrics Interface tracks your application's usage and populates the Game Analytics dashboard in the Developer Portal. This data includes active, online instances of the game's client and server, and past sessions played by local players. All Metrics Interface calls take a handle of type EOS_HMetrics as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetMetricsInterface function.

When writing C code that uses the Metrics Interface, include eos_metrics.h.

You can delve deeper into the Metrics Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Metrics Interface](Interfaces/Metrics) documentation page.

Mods Interface

The Mods Interface is used to manage a user's mods. Allowing a user to install/uninstall/enumerate mods. All Mods Interface calls take a handle of type EOS_HMods as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetModsInterface function. NOTE: At this time, this feature is only available for desktop platforms and for products that are part of the Epic Games store.

When writing C code that uses the Mods Interface, include eos_mods.h.

You can delve deeper into the Mods Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Mods Interface](Interfaces/Mods) documentation page.

P2P Interface

P2P functions to help manage sending and receiving of messages to peers. These functions will attempt to punch through NATs, but will fallback to using Epic relay servers if a direct connection cannot be established.

When writing C code that uses the P2P Interface, include eos_p2p.h.

You can delve deeper into the P2P Interface API for a complete technical reference, or receive guidance and usage instructions from the main [P2P Interface](Interfaces/P2P) documentation page.

PlayerDataStorage Interface

The following EOS_PlayerDataStorage_* functions allow you to query file metadata; create/upload files; and duplicate, read, and delete existing files

When writing C code that uses the PlayerDataStorage Interface, include eos_playerdatastorage.h.

You can delve deeper into the PlayerDataStorage Interface API for a complete technical reference, or receive guidance and usage instructions from the main [PlayerDataStorage Interface](Interfaces/PlayerDataStorage) documentation page.

Presence Interface

The Presence methods enable you to query and read other player's presence information, or modify your own. QueryPresence must be called once per login, per remote user, before data will be available. It is currently only possible to query presence for users that are on your friends list, all other queries will return no results.

When writing C code that uses the Presence Interface, include eos_presence.h.

You can delve deeper into the Presence Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Presence Interface](Interfaces/Presence) documentation page.

Reports Interface

The following EOS_Reports_* functions allow you to send reports directly from the players to the back-end services without having to route these through a game server.

When writing C code that uses the Reports Interface, include eos_reports.h.

You can delve deeper into the Reports Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Reports Interface](Interfaces/Reports) documentation page.

RTC Interface

The RTC Interface is used to manage joining and leaving rooms.

When writing C code that uses the RTC Interface, include eos_rtc.h.

You can delve deeper into the RTC Interface API for a complete technical reference, or receive guidance and usage instructions from the main [RTC Interface](Interfaces/RTC) documentation page.

Sanctions Interface

When writing C code that uses the Sanctions Interface, include eos_sanctions.h.

You can delve deeper into the Sanctions Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Sanctions Interface](Interfaces/Sanctions) documentation page.

Sessions Interface

The Session Interface is used to manage sessions that can be advertised with the backend service All Session Interface calls take a handle of type EOS_HSessions as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetSessionsInterface function.

When writing C code that uses the Sessions Interface, include eos_sessions.h.

You can delve deeper into the Sessions Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Sessions Interface](Interfaces/Sessions) documentation page.

Stats Interface

The Stats Interface manages user stats like number of items collected, fastest completion time for a level, number of wins/losses, number of times that a user has performed a certain action, and so on. You can use stats to determine when to unlock achievements and how to use rank users in leaderboards. All Stats Interface calls take a handle of type EOS_HStats as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetStatsInterface function.

When writing C code that uses the Stats Interface, include eos_stats.h.

You can delve deeper into the Stats Interface API for a complete technical reference, or receive guidance and usage instructions from the main [Stats Interface](Interfaces/Stats) documentation page.

TitleStorage Interface

The following EOS_TitleStorage_* functions allow you to query metadata for available files from title storage as well as download and read their contents.

When writing C code that uses the TitleStorage Interface, include eos_titlestorage.h.

You can delve deeper into the TitleStorage Interface API for a complete technical reference, or receive guidance and usage instructions from the main [TitleStorage Interface](Interfaces/TitleStorage) documentation page.

UI Interface

The UI Interface is used to access the Social Overlay UI. Each UI component will have a function for opening it. All UI Interface calls take a handle of type EOS_HUI as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetUIInterface function.

When writing C code that uses the UI Interface, include eos_ui.h.

You can delve deeper into the UI Interface API for a complete technical reference, or receive guidance and usage instructions from the main [UI Interface](Interfaces/UI) documentation page.

UserInfo Interface

The UserInfo Interface is used to receive user information for Epic Online Services Account IDs from the backend services and to retrieve that information once it is cached. All UserInfo Interface calls take a handle of type EOS_HUserInfo as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetUserInfoInterface function.

When writing C code that uses the UserInfo Interface, include eos_userinfo.h.

You can delve deeper into the UserInfo Interface API for a complete technical reference, or receive guidance and usage instructions from the main [UserInfo Interface](Interfaces/UserInfo) documentation page.

タグ