Navigation
API > API/Plugins > API/Plugins/OnlineServicesInterface
Classes
| Type | Name | Description | |
|---|---|---|---|
| CAsSharedCallable | |||
| COnlineMetadataAvailable | Concept that checks if we have metadata for a struct | ||
| CSuperDefined | Concept that checks for the existence of a Super typedef/using declaration | ||
| FAcceptFriendInvite | |||
| FAccountInfo | |||
| FAchievementDefinition | |||
| FAchievementStatDefinition | |||
| FAchievementState | |||
| FAchievementStateUpdated | Struct for AchievementStateUpdated event | ||
| FAddSessionMember | |||
| FAsyncProgress | |||
| FAuthAccountAttributesChanged | Struct for AccountAttributesChanged event | ||
| FAuthBeginVerifiedAuthSession | |||
| FAuthCancelVerifiedAuthTicket | |||
| FAuthEndVerifiedAuthSession | |||
| FAuthGetAllLocalOnlineUsers | |||
| FAuthGetLinkAccountContinuationId | |||
| FAuthGetLocalOnlineUserByOnlineAccountId | |||
| FAuthGetLocalOnlineUserByPlatformUserId | |||
| FAuthGetRelyingParty | |||
| FAuthLinkAccount | |||
| FAuthLogin | |||
| FAuthLoginStatusChanged | Struct for LoginStatusChanged event | ||
| FAuthLogout | |||
| FAuthModifyAccountAttributes | |||
| FAuthPendingAuthExpiration | Struct for PendingAuthExpiration event | ||
| FAuthQueryExternalAuthToken | |||
| FAuthQueryExternalServerAuthTicket | |||
| FAuthQueryVerifiedAuthTicket | |||
| FBatchQueryPresence | |||
| FBatchQueryStats | |||
| FBlockUser | |||
| FClearPresenceSession | |||
| FCommerceCheckout | Initiate the checkout process for purchasing one or more offers. | ||
| FCommerceGetEntitlements | Get the complete list of cached entitlements. | ||
| FCommerceGetOffers | Get the complete list of cached offers. | ||
| FCommerceGetOffersById | Get the offers for a list of offer ids. | ||
| FCommerceOnPurchaseComplete | Event | ||
| FCommerceQueryEntitlements | Get the list of all entitlements. | ||
| FCommerceQueryOffers | |||
| FCommerceQueryOffersById | Query the offers matching specified offer ids. | ||
| FCommerceQueryTransactionEntitlements | Retrieve the list of entitlements from a transaction id returned from a checkout call. | ||
| FCommerceRedeemEntitlement | Mark an entitlement as redeemed.Used when there is no external service managing redemption of entitlements or the redemption must be done on the client side. | ||
| FCommerceRetrieveS2SToken | Get a token suitable for making service to service Commerce related calls. | ||
| FCommerceShowStoreUI | Bring up the platform store ui. | ||
| FConnectionStatusChanged | Struct for ConnectionStatusChanged event | ||
| FCreateLobby | |||
| FCreateSession | |||
| FCustomSessionSetting | User-defined data to be stored along with the session information. | ||
| FCustomSessionSettingUpdate | Contains both the old and new values for an updated FCustomSessionSetting. | ||
| FDeclineLobbyInvitation | |||
| FDisplayAchievementUI | |||
| FEntitlement | |||
| FExternalAuthToken | Token appropriate for allowing a trusted server to verify authentication. | ||
| FExternalServerAuthTicket | Ticket appropriate for allowing a trusted server to access service APIs on the users behalf. | ||
| FExternalUIShowFriendsUI | |||
| FExternalUIShowLoginUI | |||
| FExternalUIStatusChanged | Struct for ExternalUIStatusChanged event | ||
| FFindLobbies | |||
| FFindLobbySearchFilter | |||
| FFindSessions | |||
| FFindSessionsSearchFilter | Filter class for a session search, will be compared against the session's CustomSettings | ||
| FFriend | Information about a friend | ||
| FGetAchievementDefinition | |||
| FGetAchievementIds | |||
| FGetAchievementState | |||
| FGetAllSessionInvites | |||
| FGetAllSessions | |||
| FGetBlockedUsers | |||
| FGetCachedPresence | |||
| FGetCachedStats | |||
| FGetConnectionStatus | |||
| FGetFriends | |||
| FGetJoinedLobbies | |||
| FGetPresenceLobby | |||
| FGetPresenceSession | |||
| FGetReceivedInvitations | |||
| FGetResolvedConnectString | |||
| FGetSessionById | |||
| FGetSessionByName | |||
| FGetSessionInviteById | |||
| FGetUserAvatar | |||
| FGetUserInfo | |||
| FInviteLobbyMember | |||
| FIsPresenceLobby | |||
| FIsPresenceSession | |||
| FJoinLobby | |||
| FJoinSession | |||
| FKickLobbyMember | |||
| FLeaderboardEntry | |||
| FLeaveLobby | |||
| FLeaveSession | |||
| FLexToStringAdaptor | Adaptor for handling LexToString with a schema variant. | ||
| FLobby | |||
| FLobbyAttributesChanged | Struct for LobbyAttributesChanged event | ||
| FLobbyInvitationAdded | Struct for LobbyInvitationAdded event | ||
| FLobbyInvitationRemoved | Struct for LobbyInvitationRemoved event | ||
| FLobbyJoined | Struct for LobbyJoined event | ||
| FLobbyLeaderChanged | Struct for LobbyLeaderChanged event | ||
| FLobbyLeft | Struct for LobbyLeft event | ||
| FLobbyMember | |||
| FLobbyMemberAttributesChanged | Struct for LobbyMemberAttributesChanged event | ||
| FLobbyMemberJoined | Struct for LobbyMemberJoined event | ||
| FLobbyMemberLeft | Struct for LobbyMemberLeft event | ||
| FLobbySchemaChanged | Struct for LobbySchemaChanged event | ||
| FModifyLobbyAttributes | |||
| FModifyLobbyJoinPolicy | |||
| FModifyLobbyMemberAttributes | |||
| FModifyLobbySchema | |||
| FOffer | Contains all the information required to display an offer to a user. | ||
| FOnlineError | |||
| FOnlineErrorCode | Error code as struct with bitfields | ||
| FOnlineErrorDetails | |||
| FOnlineEventDelegateHandle | |||
| FOnlineServicesRegistry | |||
| FOnlineTypeName | |||
| FPartialUpdatePresence | |||
| FPresenceUpdated | Struct for PresenceUpdated event | ||
| FPromoteLobbyMember | |||
| FPurchaseOffer | |||
| FQueryAchievementDefinitions | |||
| FQueryAchievementStates | |||
| FQueryBlockedUsers | |||
| FQueryFriends | |||
| FQueryPresence | |||
| FQueryStats | |||
| FQueryUserAvatar | |||
| FQueryUserInfo | |||
| FQueryUserPrivilege | |||
| FReadEntriesAroundRank | |||
| FReadEntriesAroundUser | |||
| FReadEntriesForUsers | |||
| FRejectFriendInvite | |||
| FRejectSessionInvite | |||
| FRelationshipUpdated | Struct for RelationshipUpdated event | ||
| FRemoveSessionMember | |||
| FResetStats | |||
| FRestoreLobbies | |||
| FSchemaAttributeDefinition | The runtime definition of a schema attribute. | ||
| FSchemaAttributeDescriptor | Describes the required attribute configuration for a schema attribute. | ||
| FSchemaCategoryAttributesDescriptor | Adds a set of attributes to a given category in a given schema. | ||
| FSchemaCategoryDefinition | The runtime definition of a schema category. | ||
| FSchemaCategoryDescriptor | Describes a category within a schema. | ||
| FSchemaCategoryInstanceBase | |||
| FSchemaCategoryInstanceCommitClientChanges | |||
| FSchemaCategoryInstanceCommitServiceSnapshot | |||
| FSchemaCategoryInstanceInternalSnapshotAccessor | Schema category instance attribute accessor for providing the client attributes internally. | ||
| FSchemaCategoryInstancePrepareClientChanges | |||
| FSchemaCategoryInstancePrepareServiceSnapshot | |||
| FSchemaClientChanges | Changes from the client data to be translated into service changes. | ||
| FSchemaClientServiceChanges | Changes to be applied to the service data following client schema attribute changes. | ||
| FSchemaDefinition | The runtime definition of a schema. The contained data can be used for validation and translation. | ||
| FSchemaDescriptor | Describes all properties needed to use a schema. | ||
| FSchemaRegistry | |||
| FSchemaRegistryDescriptorConfig | Set of all descriptors used to initialize a SchemaRegistry. | ||
| FSchemaServiceAttributeData | The set of data used to write a variant to a service. | ||
| FSchemaServiceAttributeDefinition | The runtime definition of a schema service attribute. | ||
| FSchemaServiceAttributeDescriptor | Describes available options for an attribute made available by the underlying service. | ||
| FSchemaServiceClientChanges | Changes to be applied to the client data following service attribute changes. | ||
| FSchemaServiceDescriptor | Service descriptor used for declaring a set of attributes a service provides. | ||
| FSchemaServiceSnapshot | Full snapshot of all set service attributes. | ||
| FSchemaVariant | |||
| FSendFriendInvite | |||
| FSendSessionInvite | |||
| FSessionCreated | |||
| FSessionInfo | Information about an FSession that will be set at creation time and remain constant during its lifetime | ||
| FSessionInviteReceived | |||
| FSessionJoined | |||
| FSessionLeft | |||
| FSessionSettings | Set of all of an FSession's defining properties that can be updated by the session owner during its lifetime, using the FUpdateSessionSettings method | ||
| FSessionSettingsChanges | Contains updated data for any modifiable members of FSessionSettings. | ||
| FSessionSettingsUpdate | Contains new values for an FSessions modifiable settings. | ||
| FSessionUpdate | Contains updated data for any modifiable members of ISession | ||
| FSessionUpdated | |||
| FSetPresenceSession | |||
| FShowUserProfile | |||
| FStartMatchmaking | |||
| FTitleFileEnumerateFiles | |||
| FTitleFileGetEnumeratedFiles | |||
| FTitleFileReadFile | |||
| FUILobbyJoinRequested | Struct for UILobbyJoinedRequested event | ||
| FUISessionJoinRequested | |||
| FUnlockAchievements | |||
| FUpdatePresence | |||
| FUpdateSessionSettings | |||
| FUpdateStats | |||
| FUserFileCopyFile | |||
| FUserFileDeleteFile | |||
| FUserFileEnumerateFiles | |||
| FUserFileGetEnumeratedFiles | |||
| FUserFileReadFile | |||
| FUserFileWriteFile | |||
| FUserInfo | |||
| FUserPresence | |||
| FUserStats | |||
| FVerifiedAuthSession | |||
| FVerifiedAuthTicket | |||
| FWillRetry | |||
| IAchievements | |||
| IAuth | |||
| ICommerce | |||
| IConnectivity | |||
| IExternalUI | |||
| ILeaderboards | Interface definition for the leaderboards service | ||
| ILobbies | |||
| IOnlineAsyncOp | |||
| IOnlineAsyncOpSharedState | State shared between the Op and Handle. | ||
| IOnlineErrorDetails | Implementations of this would contain any contextual information about the error (eg, if an FText or FString exposed some fields to be filled in at run time), and likely the platform specific error representation (eg, NSError on apple that we can use to get a string to display to user and a string to log) | ||
| IOnlineServices | |||
| IOnlineServicesFactory | |||
| IPresence | |||
| IPrivileges | |||
| ISession | Interface to access all information related to Online Sessions. Read only | ||
| ISessionInvite | Interface to access all information about an invitation to join an Online Session. Read only | ||
| ISessions | |||
| ISocial | |||
| IStats | Stats interface is used to upload the stats to EOS or first party platforms, to complete corresponding InGame/Platform features such as Stats Query, Achievements, Leaderboard, etc. | ||
| ITitleFile | |||
| IUserFile | |||
| IUserInfo | |||
| TBaseClass | If all types in a class hierarchy have a Super typedef or using declaration, Type will be the type of the last Super definition | ||
| TBaseClassHelper | |||
| TField | |||
| TIsSharedPtrOrRef | |||
| TOnlineAsyncOpHandle | |||
| TOnlineCallback | |||
| TOnlineEvent | |||
| TOnlineEventCallable | |||
| TOnlineResult | |||
| TOnlineTypeInfo | |||
| TResult | A container that holds either a successful result or an erroneous result. | ||
| TSchemaCategoryInstance | Schema category instance class templated by access to client attributes. | ||
| TSharedPtrHelper | |||
| TSharedPtrHelper2 | |||
| TStruct | Struct field definitions, manually defined via the ONLINE_STRUCT macros below | ||
| TStructDetails | Struct that needs to be specialized to provide the Fields in the struct. |
Typedefs
| Name | Description |
|---|---|
| ErrorCodeType | |
| FCredentialsToken | Token used during Login operation. |
| FCustomSessionSettingsMap | |
| FCustomSessionSettingUpdateMap | |
| FEntitlementId | Unique identifier for an entitlement |
| FOfferId | Unique identifier for an offer |
| FOnOnlineAsyncOpCompleted | Notification that an online operation has completed |
| FOnOnlineServicesCreated | Online services delegates that are more external to the online services themselves Notification that a new online subsystem instance has been created |
| FPresenceProperties | |
| FPresenceVariant | |
| FSchemaAttributeId | The id used to refer to a schema attribute. |
| FSchemaCategoryId | Category within a schema. |
| FSchemaCategoryInstance | Default implementation with both translation and client attribute snapshot data contained within the category instance. |
| FSchemaId | Schema name - used to lookup and interact with a schema. |
| FSchemaServiceAttributeId | The id used to refer to a schema service attribute. |
| FSchemaServiceDescriptorId | The id used to refer to a schema service descriptor. |
| FSessionMemberIdsSet | |
| FStatsUpdated | |
| FStatValue | |
| FTitleFileContents | |
| FTitleFileContentsPtr | |
| FTitleFileContentsRef | |
| FTitleFileContentsWeakPtr | |
| FUserFileContents | |
| FUserFileContentsPtr | |
| FUserFileContentsRef | |
| FUserFileContentsWeakPtr | |
| IAchievementsPtr | |
| IAuthPtr | |
| ICommercePtr | |
| IConnectivityPtr | |
| IExternalUIPtr | |
| ILeaderboardsPtr | |
| ILobbiesPtr | |
| IOnlineServicesPtr | Interfaces. |
| IPresencePtr | |
| IPrivilegesPtr | |
| ISessionsPtr | |
| ISocialPtr | |
| IStatsPtr | |
| ITitleFilePtr | |
| IUserFilePtr | |
| IUserInfoPtr | |
| TBaseClass_T | Convenience template alias for TBaseClass |
Enums
| Type | Name | Description | |
|---|---|---|---|
| UE::Online::EAsyncOpState | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::EExternalAuthTokenMethod | Some auth interfaces have more than one method for providing credentials when linking to an external account. | ||
| UE::Online::ELobbyJoinPolicy | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::ELobbyMemberLeaveReason | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::ELoginStatus | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::EOfferType | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::EOnlineServicesConnectionStatus | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::EPrivilegeResults | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::ERelationship | Social relationship status | ||
| UE::Online::ERemoteAuthTicketAudience | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::ESchemaAttributeComparisonOp | Flags to indicate comparison types between Schema Attributes. Used in searches | ||
| UE::Online::ESchemaAttributeFlags | Flags to indicate required properties for a schema attribute. | ||
| UE::Online::ESchemaAttributeType | Flags to indicate the data types supported by a service attribute. | ||
| UE::Online::ESchemaAttributeVisibility | TODO: This enum fulfills the same function as the attribute flags, and will be removed once full Schema support is added to Sessions/Lobbies/Auth. | ||
| UE::Online::ESchemaServiceAttributeFlags | Flags to indicate the available support for a service attribute. | ||
| UE::Online::ESchemaServiceAttributeSupportedTypeFlags | Flags to indicate the data types supported by a service attribute. | ||
| UE::Online::ESessionJoinPolicy | Set of options to reflect how a session may be discovered in searches and joined | ||
| UE::Online::EUILobbyJoinRequestedSource | Lobby join requested source | ||
| UE::Online::EUISessionJoinRequestedSource | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::EUserPresenceGameStatus | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::EUserPresenceJoinability | Copyright Epic Games, Inc. All Rights Reserved. | ||
| UE::Online::EUserPresenceStatus | Todo: add more potential errors here | ||
| UE::Online::EUserPrivileges | Copyright Epic Games, Inc. All Rights Reserved. |
Functions
Variables
| Type | Name | Description | |
|---|---|---|---|
| AccessDenied | |||
| AccountId | |||
| AlreadyLoggedIn | |||
| AlreadyPending | |||
| AlreadyUnlocked | |||
| AttributeName | |||
| Cancelled | |||
| CannotQueryLocalUsers | |||
| CantParse | |||
| Data | |||
| const ErrorCodeType | Engine | ||
| EntitlementId | |||
| FriendId | |||
| const ErrorCodeType | Game | ||
| Id | |||
| IncompatibleVersion | |||
| InvalidAuth | |||
| InvalidCreds | |||
| InvalidParams | |||
| InvalidResults | |||
| InvalidState | |||
| InvalidUser | |||
| Key | |||
| LobbyId | |||
| MissingInterface | |||
| NoChange | |||
| NoConnection | |||
| NotConfigured | |||
| NotFound | |||
| NotImplemented | |||
| NotLoggedIn | |||
| OfferId | |||
| OldValue | |||
| RequestFailure | |||
| SchemaDescriptors | |||
| SchemaId | |||
| SchemaName | |||
| SessionId | |||
| Success | |||
| const ErrorCodeType | ThirdPartyPlugin | ||
| Timeout | |||
| TooManyRequests | |||
| Type | |||
| Unknown | |||
| WillRetry |