Friends
Summary
| Members | Descriptions |
|---|---|
enum FriendshipStatus | Status of players’ friend relationship. |
class URH_PlatformFriend | Platform Friend class tracks all the information for a user you have a relationship with on your platform. |
class URH_RHFriendAndPlatformFriend | RH Friend and Platform Friend class that wraps a Rally Here Friend and Platform Friend together. |
class URH_FriendSubsystem | Friends Subsystem for handling a users relationships with other players. |
Members
enum FriendshipStatus
| Values | Descriptions |
|---|---|
| RH_None | Not friends |
| RH_Friends | Mutual friends |
| RH_FriendRequestSent | Friend request has been sent to other player |
| RH_FriendRequestPending | Friend request has been sent by other player |
| RH_FriendRequestDeclinedByOther | Friend request declined by other player |
Status of players’ friend relationship.
class URH_PlatformFriend
class URH_PlatformFriend
: public UObject
Platform Friend class tracks all the information for a user you have a relationship with on your platform.
Summary
| Members | Descriptions |
|---|---|
public inline FString GetClientDisplayName() const | Gets the display name of the user on their platform. |
public inline FString GetRichPresenceInfo() const | Gets the rich presence of the user on their platform. |
public inline const FRH_PlayerPlatformId&GetPlayerPlatformId() const | Gets a struct of the players platform and unique platform player id. |
public inline ERHAPI_Platform GetPlatform() const | Gets the type of platform. |
public inline UE_DEPRECATED(5. 0,"Use GetPlatform() instead of GetPlatformBase()") const | Gets the type of platform. |
public inline const FString & GetPlatformUserId() const | Gets the users unique platform player id. |
public inline bool IsJoinable() const | Gets if you are able to join the user in their gaming session. |
public inline bool IsPlayingGame() const | Gets if the user is playing any game. |
public inline bool IsPlayingThisGame() const | Gets if the user is playing this game. |
public inline bool IsOnline() const | Gets if the user is online on their platform. |
public inline bool IsDND() const | Gets if the user has set Do Non Disturb mode on their platform. |
public inline bool IsFriend() const | Gets if the user is your friend on their platform. |
public inline bool IsBlocked() const | Gets if the user is blocked by you on their platform. |
public inline bool HasPendingFriendRequestToYou() const | Gets if the user has sent a friend request to you on their platform. |
public inline bool HasPendingFriendRequestFromYou() const | Gets if the user has been sent a friend request by you on their platform. |
public inline bool HasAnyRelationship() const | Gets if the user is a friend or has been sent or has sent a friend request on their platform with you. |
public inline void Clear() | Clears all the info. |
public inline void ClearFriendAndStatusInfo() | Clears all the status information but not the users id. |
public inline void Init(URH_PlatformFriend * other) | Initializes a Platform Friend with another Platform Friend. |
public inline void Init(const FOnlineFriend & OnlineFriend,const FOnlineUserPresence & Presence,IOnlineSubsystem * OSS) | Initializes a Platform Friend from online information from their platform. |
protected FRH_PlayerPlatformId PlayerPlatformId | The players Platform Id. |
protected FString DisplayName | The players Display Name for the platform. |
protected FString RichPresenceInfo | The players Rich Presence on the platform. |
protected bool Joinable | If the player is currently joinable. |
protected bool PlayingGame | If the player is currently playering a game. |
protected bool PlayingThisGame | If the player is currently playing this game. |
protected bool Online | If the player is online. |
protected bool DoNotDisturb | If the player has do not disturb on. |
protected bool Friend | If the player is a platform friend. |
protected bool Blocked | If the player is blocked by you by platform. |
protected bool PendingFriendRequestToYou | If the player is requesting your friendship via platform. |
protected bool PendingFriendRequestFromYou | If the player has a pendinf friendship request via platform. |
Members
public inline FString GetClientDisplayName() const
Gets the display name of the user on their platform.
public inline FString GetRichPresenceInfo() const
Gets the rich presence of the user on their platform.
public inline const FRH_PlayerPlatformId&GetPlayerPlatformId() const
Gets a struct of the players platform and unique platform player id.
public inline ERHAPI_Platform GetPlatform() const
Gets the type of platform.
public inline UE_DEPRECATED(5. 0,"Use GetPlatform() instead of GetPlatformBase()") const
Gets the type of platform.
public inline const FString & GetPlatformUserId() const
Gets the users unique platform player id.
public inline bool IsJoinable() const
Gets if you are able to join the user in their gaming session.
public inline bool IsPlayingGame() const
Gets if the user is playing any game.
public inline bool IsPlayingThisGame() const
Gets if the user is playing this game.
public inline bool IsOnline() const
Gets if the user is online on their platform.
public inline bool IsDND() const
Gets if the user has set Do Non Disturb mode on their platform.
public inline bool IsFriend() const
Gets if the user is your friend on their platform.
public inline bool IsBlocked() const
Gets if the user is blocked by you on their platform.
public inline bool HasPendingFriendRequestToYou() const
Gets if the user has sent a friend request to you on their platform.
public inline bool HasPendingFriendRequestFromYou() const
Gets if the user has been sent a friend request by you on their platform.
public inline bool HasAnyRelationship() const
Gets if the user is a friend or has been sent or has sent a friend request on their platform with you.
public inline void Clear()
Clears all the info.
public inline void ClearFriendAndStatusInfo()
Clears all the status information but not the users id.
public inline void Init(URH_PlatformFriend * other)
Initializes a Platform Friend with another Platform Friend.
public inline void Init(const FOnlineFriend & OnlineFriend,const FOnlineUserPresence & Presence,IOnlineSubsystem * OSS)
Initializes a Platform Friend from online information from their platform.
protected FRH_PlayerPlatformId PlayerPlatformId
The players Platform Id.
protected FString DisplayName
The players Display Name for the platform.
protected FString RichPresenceInfo
The players Rich Presence on the platform.
protected bool Joinable
If the player is currently joinable.
protected bool PlayingGame
If the player is currently playering a game.
protected bool PlayingThisGame
If the player is currently playing this game.
protected bool Online
If the player is online.
protected bool DoNotDisturb
If the player has do not disturb on.
protected bool Friend
If the player is a platform friend.
protected bool Blocked
If the player is blocked by you by platform.
protected bool PendingFriendRequestToYou
If the player is requesting your friendship via platform.
protected bool PendingFriendRequestFromYou
If the player has a pendinf friendship request via platform.
class URH_RHFriendAndPlatformFriend
class URH_RHFriendAndPlatformFriend
: public UObject
RH Friend and Platform Friend class that wraps a Rally Here Friend and Platform Friend together.
Summary
| Members | Descriptions |
|---|---|
public FRH_OnPresenceUpdatedMulticastDynamicDelegate BLUEPRINT_OnPresenceUpdatedDelegate | Blueprint delegate to listen for presence updates. |
public FRH_OnPresenceUpdatedMulticastDelegate OnPresenceUpdatedDelegate | Native delegate to listen for presence updates. |
public class URH_FriendSubsystem*GetFriendSubsystem() const | |
public inline bool AreFriends() const | Gets if the player is a friend through Rally Here systems or their platform. |
public inline bool AreRHFriends() const | Gets if the player is a friend through Rally Here. |
public inline bool ArePlatformFriends() const | Gets if the player is a friend through their platform. |
public inline bool FriendRequestSent() const | Gets if you have sent a friend request to the player through Rally Here or their platform. |
public inline bool RHFriendRequestSent() const | Gets if you have sent a friend request to the player through Rally Here. |
public inline bool PendingFriendRequest() const | Gets if the player has sent you a friend through Rally Here or their platform. |
public inline bool RhPendingFriendRequest() const | Gets if the player has sent you a friend through Rally Here. |
public inline bool HaveRhRelationship() const | Gets if the player has any sort of relationship with you through Rally Here. |
public inline bool HaveAnyRelationship() const | Gets if the player has any sort of relationship with you through Rally Here or their platform. |
public inline bool HavePlatformRelationship() const | Gets if the player has any sort of relationship with you through their platform. |
public inline bool IsOnline() const | Gets if the player is online on their platform. |
public inline bool IsPlayingThisGame() const | Gets if the player is playing this game. |
public inline bool IsDnD() const | Gets if the player is set to Do Not Distrub on their platform. |
public inline bool OtherDeclinedFriendship() const | Gets if the player has declined your Rally Here friend request. |
public inline bool AwaitingFriendshipResponse() const | Gets if the player has an outstanding Rally Here friend request by you. |
public inline bool OtherIsAwaitingFriendshipResponse() const | Gets if the player has sent you a Rally Here friend request. |
public inline FGuid GetRHPlayerUuid() const | Gets the players unique player id. |
public inline FriendshipStatus GetStatus() const | Gets the current Rally Here relationship status with the player. |
public inline FriendshipStatus GetPreviousStatus() const | Gets the previous Rally Here relationship status with the player prior to the most recent update. |
public inline void AcknowledgeFriendUpdate() | Updates the Previous friendship status to the current friendship status for this friend. |
public inline FDateTime GetLastModifiedOn() const | Gets the last time the players friend data was modified. |
public inline FString GetNotes() const | Gets any notes the player has set for this player. |
public inline URH_PlatformFriend*GetPlatformFriendAtIndex(int32 Index) const | Gets a platform friend at given index for iterating plaform Friends. |
public inline URH_PlatformFriend*GetPlatformFriend(ERHAPI_Platform Platform) const | Gets a platform friend object for the specified platform if it exists. |
public inline URH_PlatformFriend*GetPlatformFriendBase(ERHAPI_Platform Platform) const | Gets a platform friend object for the specified platform if it exists. |
public inline const TArray< URH_PlatformFriend* >GetPlatformFriends() const | Gets all of the players platform friend entries. |
public inline const FRH_PlayerAndPlatformInfo&GetPlayerAndPlatformInfo() const | Gets the wrapper of the players RH and platform info. |
public FString GetLastKnownDisplayName(ERHAPI_Platform PreferredPlatformType) const | Gets the last known cached display name for the player. |
public void GetLastKnownDisplayNameAsync(const FTimespan & StaleThreshold,bool bForceRefresh,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameBlock Delegate) const | Gets the last known display name for the player, will request from API as needed. |
public inline void BLUEPRINT_GetLastKnownDisplayNameAsync(const FTimespan & StaleThreshold,bool bForceRefresh,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameDynamicDelegate & Delegate) | |
public void GetRHPlayerUuidAsync(const FRH_GetRHPlayerUuidBlock Delegate) | Gets the RH Player UUID for the player, will request from API as needed. As a side effect, it will update the RH Player Uuid on PlayerAndPlatformInfo. |
public inline void BLUEPRINT_GetRHPlayerUuidAsync(const FRH_GetRHPlayerUuidDynamicDelegate & Delegate) | |
protected FRH_PlayerAndPlatformInfo PlayerAndPlatformInfo | Player Info and Platform Info combined. |
protected FriendshipStatus RHFriendshipStatus | Core friendship status. |
protected FriendshipStatus PreviousRHFriendshipStatus | cached previous core friendship status. |
protected FDateTime LastModifiedOn | Last update of the current friend information. |
protected FString Notes | Notes set for the friend. |
protected TArray< URH_PlatformFriend* >PlatformFriends | Array of platforms the player has linked to their account. |
protected FString Etag | ETag of last friend update response. |
protected inline virtual void OnPresenceUpdated(URH_PlayerPresence * PlayerPresence) | Passes presence updates of the player on through internal delgates. |
protected inline virtual void ClearRHFriendStatus() | Clears the cached friendship status for the player. |
protected inline virtual void ClearPlatformFriendStatus() | Clears cached data for the platform friends for this player. |
Members
public FRH_OnPresenceUpdatedMulticastDynamicDelegate BLUEPRINT_OnPresenceUpdatedDelegate
Blueprint delegate to listen for presence updates.
public FRH_OnPresenceUpdatedMulticastDelegate OnPresenceUpdatedDelegate
Native delegate to listen for presence updates.
public class URH_FriendSubsystem*GetFriendSubsystem() const
public inline bool AreFriends() const
Gets if the player is a friend through Rally Here systems or their platform.
public inline bool AreRHFriends() const
Gets if the player is a friend through Rally Here.
public inline bool ArePlatformFriends() const
Gets if the player is a friend through their platform.
public inline bool FriendRequestSent() const
Gets if you have sent a friend request to the player through Rally Here or their platform.
public inline bool RHFriendRequestSent() const
Gets if you have sent a friend request to the player through Rally Here.
public inline bool PendingFriendRequest() const
Gets if the player has sent you a friend through Rally Here or their platform.
public inline bool RhPendingFriendRequest() const
Gets if the player has sent you a friend through Rally Here.
public inline bool HaveRhRelationship() const
Gets if the player has any sort of relationship with you through Rally Here.
public inline bool HaveAnyRelationship() const
Gets if the player has any sort of relationship with you through Rally Here or their platform.
public inline bool HavePlatformRelationship() const
Gets if the player has any sort of relationship with you through their platform.
public inline bool IsOnline() const
Gets if the player is online on their platform.
public inline bool IsPlayingThisGame() const
Gets if the player is playing this game.
public inline bool IsDnD() const
Gets if the player is set to Do Not Distrub on their platform.
public inline bool OtherDeclinedFriendship() const
Gets if the player has declined your Rally Here friend request.
public inline bool AwaitingFriendshipResponse() const
Gets if the player has an outstanding Rally Here friend request by you.
public inline bool OtherIsAwaitingFriendshipResponse() const
Gets if the player has sent you a Rally Here friend request.
public inline FGuid GetRHPlayerUuid() const
Gets the players unique player id.
public inline FriendshipStatus GetStatus() const
Gets the current Rally Here relationship status with the player.
public inline FriendshipStatus GetPreviousStatus() const
Gets the previous Rally Here relationship status with the player prior to the most recent update.
public inline void AcknowledgeFriendUpdate()
Updates the Previous friendship status to the current friendship status for this friend.
public inline FDateTime GetLastModifiedOn() const
Gets the last time the players friend data was modified.
public inline FString GetNotes() const
Gets any notes the player has set for this player.
public inline URH_PlatformFriend*GetPlatformFriendAtIndex(int32 Index) const
Gets a platform friend at given index for iterating plaform Friends.
public inline URH_PlatformFriend*GetPlatformFriend(ERHAPI_Platform Platform) const
Gets a platform friend object for the specified platform if it exists.
public inline URH_PlatformFriend*GetPlatformFriendBase(ERHAPI_Platform Platform) const
Gets a platform friend object for the specified platform if it exists.
public inline const TArray< URH_PlatformFriend* >GetPlatformFriends() const
Gets all of the players platform friend entries.
public inline const FRH_PlayerAndPlatformInfo&GetPlayerAndPlatformInfo() const
Gets the wrapper of the players RH and platform info.
public FString GetLastKnownDisplayName(ERHAPI_Platform PreferredPlatformType) const
Gets the last known cached display name for the player.
Parameters
PreferredPlatformTypeThe preferred platform to get the display name from.
Returns
The players last seen display name, will try to find a valid display name even if on a different platform than the preferred.
public void GetLastKnownDisplayNameAsync(const FTimespan & StaleThreshold,bool bForceRefresh,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameBlock Delegate) const
Gets the last known display name for the player, will request from API as needed.
Parameters
-
PlayerInfoSubsystemThe subsystem to use for the lookup -
StaleThresholdThe time threshold to consider the cached display name stale. -
bForceRefreshIf true will force a request from the API. -
PreferredPlatformTypeThe preferred platform to get the display name from. -
DelegateThe delegate to call when the request is complete.
public inline void BLUEPRINT_GetLastKnownDisplayNameAsync(const FTimespan & StaleThreshold,bool bForceRefresh,ERHAPI_Platform PreferredPlatformType,const FRH_PlayerInfoGetDisplayNameDynamicDelegate & Delegate)
public void GetRHPlayerUuidAsync(const FRH_GetRHPlayerUuidBlock Delegate)
Gets the RH Player UUID for the player, will request from API as needed. As a side effect, it will update the RH Player Uuid on PlayerAndPlatformInfo.
Parameters
DelegateThe delegate to call when the request is complete.
public inline void BLUEPRINT_GetRHPlayerUuidAsync(const FRH_GetRHPlayerUuidDynamicDelegate & Delegate)
protected FRH_PlayerAndPlatformInfo PlayerAndPlatformInfo
Player Info and Platform Info combined.
protected FriendshipStatus RHFriendshipStatus
Core friendship status.
protected FriendshipStatus PreviousRHFriendshipStatus
cached previous core friendship status.
protected FDateTime LastModifiedOn
Last update of the current friend information.
protected FString Notes
Notes set for the friend.
protected TArray< URH_PlatformFriend* >PlatformFriends
Array of platforms the player has linked to their account.
protected FString Etag
ETag of last friend update response.
protected inline virtual void OnPresenceUpdated(URH_PlayerPresence * PlayerPresence)
Passes presence updates of the player on through internal delgates.
Parameters
PlayerPresenceThe players precence information.
protected inline virtual void ClearRHFriendStatus()
Clears the cached friendship status for the player.
protected inline virtual void ClearPlatformFriendStatus()
Clears cached data for the platform friends for this player.
class URH_FriendSubsystem
class URH_FriendSubsystem
: public URH_LocalPlayerSubsystemPlugin
Friends Subsystem for handling a users relationships with other players.
Summary
| Members | Descriptions |
|---|---|
public FRH_FriendListUpdatedDelegate FriendListUpdatedDelegate | Delegate that fires whenever the friends list is updated. |
public FRH_FriendListUpdatedDynamicDelegate BLUEPRINT_FriendListUpdatedDelegate | Delegate that fires whenever the friends list is updated. |
public FRH_FriendUpdatedDelegate FriendUpdatedDelegate | Delegate that fires whenever a friend is updated. |
public FRH_FriendUpdatedDynamicDelegate BLUEPRINT_FriendUpdatedDelegate | Delegate that fires whenever a friend is updated. |
public FRH_FriendUpdateErrorDelegate FriendUpdateErrorDelegate | Delegate that fires whenever a friend API call fails. |
public FRH_FriendUpdateErrorDynamicDelegate BLUEPRINT_FriendUpdateErrorDelegate | Delegate that fires whenever a friend API call fails. |
public FRH_BlockedListUpdatedDelegate BlockedListUpdatedDelegate | Delegate that fires whenever blocked players list is updated. |
public FRH_BlockedListUpdatedDynamicDelegate BLUEPRINT_BlockedListUpdatedDelegate | Delegate that fires whenever blocked players list is updated. |
public FRH_BlockedPlayerUpdatedDelegate BlockedPlayerUpdatedDelegate | Delegate that fires whenever a blocked player is updated. |
public FRH_BlockedPlayerUpdatedDynamicDelegate BLUEPRINT_BlockedPlayerUpdatedDelegate | Delegate that fires whenever a blocked player is updated. |
public FRH_BlockedPlayerUpdateErrorDelegate BlockedPlayerUpdateErrorDelegate | Delegate that fires whenever blocked player API call fails. |
public FRH_BlockedPlayerUpdateErrorDynamicDelegate BLUEPRINT_BlockedPlayerUpdateErrorDelegate | Delegate that fires whenever blocked player API call fails. |
public virtual void Initialize() | Initialize the subsystem. |
public virtual void Deinitialize() | Safely tears down the subsystem. |
public URH_PlayerInfoSubsystem*GetRH_PlayerInfoSubsystem() const | Helper function to get the Player Info Subsystem that owns this. |
public bool FetchFriendsList(FRH_GenericFriendBlock Delegate) | Calls the Friends API to get the players friends list. |
public inline bool BLUEPRINT_FetchFriendsList(const FRH_GenericFriendDynamicDelegate & Delegate) | |
public bool FetchFriend(const FGuid & PlayerUUID,FRH_GenericFriendWithUuidBlock Delegate) | Calls the Friends API to get data for a specific friend. |
public inline bool BLUEPRINT_FetchFriend(UPARAM(ref) const FGuid & PlayerUUID,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate) | |
public bool AddFriend(const FGuid & PlayerUuid,FRH_AddFriendBlock Delegate) | Calls the Friends API to create a new friendship relationship with another player. |
public inline bool BLUEPRINT_AddFriend(UPARAM(ref) const FGuid & PlayerUuid,const FRH_AddFriendDynamicDelegate & Delegate) | |
public bool RemoveFriend(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate) | Calls the Friends API to remove a friend relationship with another player. |
public inline bool BLUEPRINT_RemoveFriend(UPARAM(ref) const FGuid & PlayerUuid,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate) | |
public bool AddNotes(const FGuid & PlayerUuid,const FString & Notes,FRH_AddNotesBlock Delegate) | Calls the Friends API to set/modify personal notes for another player. |
public inline bool BLUEPRINT_AddNotes(UPARAM(ref) const FGuid & PlayerUuid,UPARAM(ref) const FString & Notes,const FRH_AddNotesDynamicDelegate & Delegate) | |
public bool DeleteNotes(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate) | Calls the Friends API to delete personal notes for another player. |
public inline bool BLUEPRINT_DeleteNotes(UPARAM(ref) const FGuid & PlayerUuid,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate) | |
public bool FetchBlockedList(FRH_GenericFriendBlock Delegate) | Calls the Friends API to get the list of players you have blocked. |
public inline bool BLUEPRINT_FetchBlockedList(const FRH_GenericFriendDynamicDelegate & Delegate) | |
public bool FetchBlockedPlayer(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate) | Calls the Friends API to get data for a specific blocked player. |
public inline bool BLUEPRINT_FetchBlockedPlayer(UPARAM(ref) const FGuid & PlayerUuid,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate) | |
public bool BlockPlayer(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate) | Calls the Friends API to create a new block relationship with another player. |
public inline bool BLUEPRINT_BlockPlayer(UPARAM(ref) const FGuid & PlayerUUID,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate) | |
public bool UnblockPlayer(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate) | Calls the Friends API to remove a block relationship with another player. |
public inline bool BLUEPRINT_UnblockPlayer(UPARAM(ref) const FGuid & PlayerUuid,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate) | |
public void UpdateRecentPlayerForOSS(const URH_LocalPlayerSubsystem * LocalPlayerSubsystem,const FGuid & PlayerUuid) | Updates the platform OSS with a player you have recently played with. |
public void OSSReadFriendsList(const FString & ListName) | Triggers the OSS call to get platform friends. |
public URH_RHFriendAndPlatformFriend*GetOrCreateFriend(URH_PlayerInfo * PlayerInfo) | Gets if the specified players friend wrapper, or creates one if it doesn’t exist yet. |
public URH_RHFriendAndPlatformFriend*GetFriendByUuid(const FGuid & PlayerUuid) const | Gets the cached friend wrapper for the specified player. |
public URH_RHFriendAndPlatformFriend*GetFriendByPlayerInfo(URH_PlayerInfo * PlayerInfo) const | Gets the cached friend wrapper for the specified player. |
public URH_RHFriendAndPlatformFriend*GetFriendByPlatformId(const FRH_PlayerPlatformId & PlatformPlayerId) const | Gets the cached friend wrapper for the specified player. |
public URH_RHFriendAndPlatformFriend*GetFriendByUuidOrPlatformId(const FGuid & PlayerUuid,const FRH_PlayerPlatformId & PlatformPlayerId) const | Gets the cached friend wrapper for the specified player. |
public inline bool IsPlayerBlocked(const FGuid & PlayerUuid) const | Gets if the specified player is blocked via platform or Rally Here. |
public inline bool IsPlayerPlatformBlocked(const FGuid & PlayerUuid) const | Gets if the specified player is blocked via platform. |
public inline bool IsPlayerRhBlocked(const FGuid & PlayerUuid) const | Gets if the specified player is blocked via Rally Here. |
public void StartFriendsRefreshTimer() | Starts the polling for Rally Here friends. |
public void StopFriendsRefreshTimer() | Stops the polling for Rally Here friends. |
public void StartBlockedRefreshTimer() | Starts the polling for blocked players. |
public void StopBlockedRefreshTimer() | Stops the polling for blocked players. |
public void ClearBlockedCache() | Clears the cache of blocked players. |
public void ClearRHFriendCache() | Clears the cache of Rally Here friends. |
public inline const TArray< URH_RHFriendAndPlatformFriend* > &GetFriends() const | Gets an array of your friends. |
public inline const TArray< FGuid > & GetBlocked() const | Gets an array of blocked player ids. |
public inline bool HasFriendsCached() const | Gets if the subsystem has cached friend data. |
protected TArray< URH_RHFriendAndPlatformFriend* >Friends | Cached array of all friends. |
protected TArray< FGuid > BlockedPlayersUUIDs | Array of blocked player ids. |
protected FString FriendsETag | ETag of last Get Friends List call response. |
protected FString BlockedPlayersETag | ETag of last Get Blocked Players call response. |
protected bool FriendsCached | Tracks if friends are currently cached. |
protected FRH_AutoPollerPtr FriendsListPoller | Poller for getting friends list. |
protected FRH_AutoPollerPtr BlockedListPoller | Poller for getting blocked players list. |
protected FDelegateHandle OnOSSPresenceReceivedHandle | Delegate to be fired when online subsystem presence is received. |
protected virtual void OnUserChanged() | Callback that occurs whenever the local player this subsystem is associated with changes. |
protected virtual void InitPropertiesWithDefaultValues() | Initializes the subsystem with defaults for its cached data. |
protected virtual bool SetDefaultParamsForGetFriendRequest(GetFriendRelationshipType::Request & Request) const | Fills our a Get Friend request. |
protected virtual void PostReloadConfig(class FProperty * PropertyThatWasLoaded) | Called from ReloadConfig after the object has reloaded its configuration data. |
protected inline virtual void OnPresenceUpdated(URH_PlayerPresence * PlayerPresence) | Helper function to push out presence updates on delegates on this system. |
protected virtual void OnFetchFriendsListResponse(const GetFriendsListType::Response & Resp,FRH_GenericFriendBlock Delegate) | Handles the response to a Fetch Friend List call. |
protected virtual void OnFetchFriendResponse(const GetFriendRelationshipType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate) | Handles the response to a Fetch Friend call. |
protected virtual void OnAddFriendResponse(const AddFriendType::Response & Resp,FRH_AddFriendBlock Delegate,AddFriendType::Request Request,int32 RetryEtagFailureCount) | Handles the response to a Add Friend call. |
protected virtual void OnRemoveFriendResponse(const DeleteFriendType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,DeleteFriendType::Request Request,int32 RetryEtagFailureCount) | Handles the response to a Remove Friend call. |
protected virtual void OnAddNotesResponse(const AddNotesType::Response & Resp,FRH_AddNotesBlock Delegate,AddNotesType::Request Request,int32 RetryEtagFailureCount) | Handles the response to a Add Friend Notes call. |
protected virtual void OnDeleteNotesResponse(const DeleteNotesType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,DeleteNotesType::Request Request,int32 RetryEtagFailureCount) | Handles the response to a Delete Friend Notes call. |
protected virtual void OnFetchBlockedListResponse(const GetBlockedListType::Response & Resp,FRH_GenericFriendBlock Delegate) | Handles the response to a Get Blocked List call. |
protected virtual void OnFetchBlockedPlayerResponse(const GetBlockedType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,const FGuid PlayerUuid) | Handles the response to a Get Blocked Player call. |
protected virtual void OnBlockPlayerResponse(const BlockType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,const FGuid PlayerUuid) | Handles the response to a Block Player call. |
protected virtual void OnUnblockPlayerResponse(const UnblockType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,const FGuid PlayerUuid) | Handles the response to a Unblock Player call. |
protected virtual void OnFetchFriendForAdd(const GetFriendRelationshipType::Response & Resp,FRH_AddFriendBlock Delegate,AddFriendType::Request Request,int32 RetryEtagFailureCount) | Handles the response to a Fetch Friend For Add call. |
protected virtual void OnFetchFriendForAddNote(const GetFriendRelationshipType::Response & Resp,FRH_AddNotesBlock Delegate,AddNotesType::Request Request,int32 RetryEtagFailureCount) | Handles the response to a Fetch Friend For Add Note call. |
protected virtual void OnFetchFriendForDeleteNote(const GetFriendRelationshipType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,DeleteNotesType::Request Request,int32 RetryEtagFailureCount) | Handles the response to a Fetch Friend For Delete Note call. |
protected virtual void OnFetchFriendForRemove(const GetFriendRelationshipType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,DeleteFriendType::Request Request,int32 RetryEtagFailureCount) | Handles the response to a Fetch Friend For Remove call. |
protected void UpdatePlatformFriends(TArray< URH_PlatformFriend * > & NewFriends) | Updates the cached Platforms friends with the new set of friends data. |
protected void RemoveAllFriendsWithNoRelationships(TArray< URH_RHFriendAndPlatformFriend * > & OutArray) | Removes all friends from the cached data that have no relationship to the player the subsystem is for. |
protected void PollFriendsList(const FRH_PollCompleteFunc & Delegate) | Executes a poll of the players friends list. |
protected void PollBlockedPlayers(const FRH_PollCompleteFunc & Delegate) | Executes a poll of the players blocked list. |
protected FName ExtractErrorCodeFromResponse(const FHttpResponsePtr & Response) const | Gets the error code response name from a http request. |
protected virtual void OnReadOSSFriendsComplete(int32 LocalUserNum,bool bWasSuccessful,const FString & ListName,const FString & ErrorStr) | Handles the response from the online subsystem call to get friends. |
protected virtual void UpdateWithOSSFriends(const FString & ListName) | Updates the system with the friends from the online subsystem. |
protected virtual void OnOSSPresenceReceived(const FUniqueNetId & UserId,const TSharedRef< FOnlineUserPresence > & NewPresence) | Handles the response from the online subsystem call to get presence. |
typedef GetBlockedListType | Type Define for Get Blocked List calls. |
typedef GetBlockedType | Type Define for Get Blocked calls. |
typedef BlockType | Type Define for Block Player calls. |
typedef UnblockType | Type Define for Unblock Player calls. |
typedef GetFriendsListType | Type Define for Get Friends List calls. |
typedef GetFriendRelationshipType | Type Define for Get Friend Relationship calls. |
typedef AddFriendType | Type Define for Add Friend calls. |
typedef DeleteFriendType | Type Define for Remove Friend calls. |
typedef AddNotesType | Type Define for Add Friend Notes calls. |
typedef DeleteNotesType | Type Define for Delete Friend Notes calls. |
Members
public FRH_FriendListUpdatedDelegate FriendListUpdatedDelegate
Delegate that fires whenever the friends list is updated.
public FRH_FriendListUpdatedDynamicDelegate BLUEPRINT_FriendListUpdatedDelegate
Delegate that fires whenever the friends list is updated.
public FRH_FriendUpdatedDelegate FriendUpdatedDelegate
Delegate that fires whenever a friend is updated.
public FRH_FriendUpdatedDynamicDelegate BLUEPRINT_FriendUpdatedDelegate
Delegate that fires whenever a friend is updated.
public FRH_FriendUpdateErrorDelegate FriendUpdateErrorDelegate
Delegate that fires whenever a friend API call fails.
public FRH_FriendUpdateErrorDynamicDelegate BLUEPRINT_FriendUpdateErrorDelegate
Delegate that fires whenever a friend API call fails.
public FRH_BlockedListUpdatedDelegate BlockedListUpdatedDelegate
Delegate that fires whenever blocked players list is updated.
public FRH_BlockedListUpdatedDynamicDelegate BLUEPRINT_BlockedListUpdatedDelegate
Delegate that fires whenever blocked players list is updated.
public FRH_BlockedPlayerUpdatedDelegate BlockedPlayerUpdatedDelegate
Delegate that fires whenever a blocked player is updated.
public FRH_BlockedPlayerUpdatedDynamicDelegate BLUEPRINT_BlockedPlayerUpdatedDelegate
Delegate that fires whenever a blocked player is updated.
public FRH_BlockedPlayerUpdateErrorDelegate BlockedPlayerUpdateErrorDelegate
Delegate that fires whenever blocked player API call fails.
public FRH_BlockedPlayerUpdateErrorDynamicDelegate BLUEPRINT_BlockedPlayerUpdateErrorDelegate
Delegate that fires whenever blocked player API call fails.
public virtual void Initialize()
Initialize the subsystem.
public virtual void Deinitialize()
Safely tears down the subsystem.
public URH_PlayerInfoSubsystem*GetRH_PlayerInfoSubsystem() const
Helper function to get the Player Info Subsystem that owns this.
public bool FetchFriendsList(FRH_GenericFriendBlock Delegate)
Calls the Friends API to get the players friends list.
Parameters
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_FetchFriendsList(const FRH_GenericFriendDynamicDelegate & Delegate)
public bool FetchFriend(const FGuid & PlayerUUID,FRH_GenericFriendWithUuidBlock Delegate)
Calls the Friends API to get data for a specific friend.
Parameters
-
PlayerUUIDThe unique player id of the friend to get. -
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_FetchFriend(UPARAM(ref) const FGuid & PlayerUUID,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate)
public bool AddFriend(const FGuid & PlayerUuid,FRH_AddFriendBlock Delegate)
Calls the Friends API to create a new friendship relationship with another player.
Parameters
-
PlayerUUIDThe unique player id of the player to add. -
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_AddFriend(UPARAM(ref) const FGuid & PlayerUuid,const FRH_AddFriendDynamicDelegate & Delegate)
public bool RemoveFriend(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate)
Calls the Friends API to remove a friend relationship with another player.
Parameters
-
PlayerUUIDThe unique player id of the friend to remove. -
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_RemoveFriend(UPARAM(ref) const FGuid & PlayerUuid,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate)
public bool AddNotes(const FGuid & PlayerUuid,const FString & Notes,FRH_AddNotesBlock Delegate)
Calls the Friends API to set/modify personal notes for another player.
Parameters
-
PlayerUUIDThe unique player id of the friend to remove. -
NotesThe notes to set for the player. -
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_AddNotes(UPARAM(ref) const FGuid & PlayerUuid,UPARAM(ref) const FString & Notes,const FRH_AddNotesDynamicDelegate & Delegate)
public bool DeleteNotes(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate)
Calls the Friends API to delete personal notes for another player.
Parameters
-
PlayerUUIDThe unique player id of the friend to whose notes will be modified. -
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_DeleteNotes(UPARAM(ref) const FGuid & PlayerUuid,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate)
public bool FetchBlockedList(FRH_GenericFriendBlock Delegate)
Calls the Friends API to get the list of players you have blocked.
Parameters
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_FetchBlockedList(const FRH_GenericFriendDynamicDelegate & Delegate)
public bool FetchBlockedPlayer(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate)
Calls the Friends API to get data for a specific blocked player.
Parameters
-
PlayerUUIDThe unique player id of the blocked player to get. -
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_FetchBlockedPlayer(UPARAM(ref) const FGuid & PlayerUuid,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate)
public bool BlockPlayer(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate)
Calls the Friends API to create a new block relationship with another player.
Parameters
-
PlayerUUIDThe unique player id of the player to block. -
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_BlockPlayer(UPARAM(ref) const FGuid & PlayerUUID,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate)
public bool UnblockPlayer(const FGuid & PlayerUuid,FRH_GenericFriendWithUuidBlock Delegate)
Calls the Friends API to remove a block relationship with another player.
Parameters
-
PlayerUUIDThe unique player id of the blocked player to unblock. -
DelegateCallback delegate for when the call completes.
Returns
If true, the call was executed.
public inline bool BLUEPRINT_UnblockPlayer(UPARAM(ref) const FGuid & PlayerUuid,const FRH_GenericFriendWithUuidDynamicDelegate & Delegate)
public void UpdateRecentPlayerForOSS(const URH_LocalPlayerSubsystem * LocalPlayerSubsystem,const FGuid & PlayerUuid)
Updates the platform OSS with a player you have recently played with.
Parameters
-
LocalPlayerSubsystemThe local player subsystem to obtain the unique net id from. -
PlayerUuidThe recently player with players Unique Player Id.
public void OSSReadFriendsList(const FString & ListName)
Triggers the OSS call to get platform friends.
public URH_RHFriendAndPlatformFriend*GetOrCreateFriend(URH_PlayerInfo * PlayerInfo)
Gets if the specified players friend wrapper, or creates one if it doesn’t exist yet.
Parameters
PlayerInfoThe player info to get the friend wrapper for.
Returns
The friend wrapper for the specified player.
public URH_RHFriendAndPlatformFriend*GetFriendByUuid(const FGuid & PlayerUuid) const
Gets the cached friend wrapper for the specified player.
Parameters
PlayerUuidThe unique player Id for the requested friend wrapper.
public URH_RHFriendAndPlatformFriend*GetFriendByPlayerInfo(URH_PlayerInfo * PlayerInfo) const
Gets the cached friend wrapper for the specified player.
Parameters
PlayerInfoThe player info to get the friend wrapper for.
public URH_RHFriendAndPlatformFriend*GetFriendByPlatformId(const FRH_PlayerPlatformId & PlatformPlayerId) const
Gets the cached friend wrapper for the specified player.
Parameters
PlatformPlayerIdThe player platform id to get the friend wrapper for.
public URH_RHFriendAndPlatformFriend*GetFriendByUuidOrPlatformId(const FGuid & PlayerUuid,const FRH_PlayerPlatformId & PlatformPlayerId) const
Gets the cached friend wrapper for the specified player.
Parameters
-
PlayerUuidThe unique player Id for the requested friend wrapper. -
PlatformPlayerIdThe player platform id to get the friend wrapper for.
public inline bool IsPlayerBlocked(const FGuid & PlayerUuid) const
Gets if the specified player is blocked via platform or Rally Here.
Parameters
PlayerUuidThe unique player id of the player to check.
public inline bool IsPlayerPlatformBlocked(const FGuid & PlayerUuid) const
Gets if the specified player is blocked via platform.
Parameters
PlayerUuidThe unique player id of the player to check.
public inline bool IsPlayerRhBlocked(const FGuid & PlayerUuid) const
Gets if the specified player is blocked via Rally Here.
Parameters
PlayerUuidThe unique player id of the player to check.
public void StartFriendsRefreshTimer()
Starts the polling for Rally Here friends.
public void StopFriendsRefreshTimer()
Stops the polling for Rally Here friends.
public void StartBlockedRefreshTimer()
Starts the polling for blocked players.
public void StopBlockedRefreshTimer()
Stops the polling for blocked players.
public void ClearBlockedCache()
Clears the cache of blocked players.
public void ClearRHFriendCache()
Clears the cache of Rally Here friends.
public inline const TArray< URH_RHFriendAndPlatformFriend* > &GetFriends() const
Gets an array of your friends.
public inline const TArray< FGuid > & GetBlocked() const
Gets an array of blocked player ids.
public inline bool HasFriendsCached() const
Gets if the subsystem has cached friend data.
protected TArray< URH_RHFriendAndPlatformFriend* >Friends
Cached array of all friends.
protected TArray< FGuid > BlockedPlayersUUIDs
Array of blocked player ids.
protected FString FriendsETag
ETag of last Get Friends List call response.
protected FString BlockedPlayersETag
ETag of last Get Blocked Players call response.
protected bool FriendsCached
Tracks if friends are currently cached.
protected FRH_AutoPollerPtr FriendsListPoller
Poller for getting friends list.
protected FRH_AutoPollerPtr BlockedListPoller
Poller for getting blocked players list.
protected FDelegateHandle OnOSSPresenceReceivedHandle
Delegate to be fired when online subsystem presence is received.
protected virtual void OnUserChanged()
Callback that occurs whenever the local player this subsystem is associated with changes.
protected virtual void InitPropertiesWithDefaultValues()
Initializes the subsystem with defaults for its cached data.
protected virtual bool SetDefaultParamsForGetFriendRequest(GetFriendRelationshipType::Request & Request) const
Fills our a Get Friend request.
Parameters
RequestThe request with the default params filled out.
Returns
True, if the request was filled out successfully.
protected virtual void PostReloadConfig(class FProperty * PropertyThatWasLoaded)
Called from ReloadConfig after the object has reloaded its configuration data.
Parameters
PropertyThatWasLoadedThe property loaded.
protected inline virtual void OnPresenceUpdated(URH_PlayerPresence * PlayerPresence)
Helper function to push out presence updates on delegates on this system.
Parameters
PlayerPresenceThe Player Presence updated.
protected virtual void OnFetchFriendsListResponse(const GetFriendsListType::Response & Resp,FRH_GenericFriendBlock Delegate)
Handles the response to a Fetch Friend List call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes.
protected virtual void OnFetchFriendResponse(const GetFriendRelationshipType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate)
Handles the response to a Fetch Friend call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes.
protected virtual void OnAddFriendResponse(const AddFriendType::Response & Resp,FRH_AddFriendBlock Delegate,AddFriendType::Request Request,int32 RetryEtagFailureCount)
Handles the response to a Add Friend call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
RetryEtagFailureCountNumber of times this has failed, to determine course of action.
protected virtual void OnRemoveFriendResponse(const DeleteFriendType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,DeleteFriendType::Request Request,int32 RetryEtagFailureCount)
Handles the response to a Remove Friend call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
RequestThe Request used to make the remove friend call. -
RetryEtagFailureCountNumber of times this has failed, to determine course of action.
protected virtual void OnAddNotesResponse(const AddNotesType::Response & Resp,FRH_AddNotesBlock Delegate,AddNotesType::Request Request,int32 RetryEtagFailureCount)
Handles the response to a Add Friend Notes call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
RetryEtagFailureCountNumber of times this has failed, to determine course of action.
protected virtual void OnDeleteNotesResponse(const DeleteNotesType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,DeleteNotesType::Request Request,int32 RetryEtagFailureCount)
Handles the response to a Delete Friend Notes call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
RetryEtagFailureCountNumber of times this has failed, to determine course of action.
protected virtual void OnFetchBlockedListResponse(const GetBlockedListType::Response & Resp,FRH_GenericFriendBlock Delegate)
Handles the response to a Get Blocked List call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes.
protected virtual void OnFetchBlockedPlayerResponse(const GetBlockedType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,const FGuid PlayerUuid)
Handles the response to a Get Blocked Player call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
PlayerUuidThe UUID of the player that is being requested.
protected virtual void OnBlockPlayerResponse(const BlockType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,const FGuid PlayerUuid)
Handles the response to a Block Player call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
PlayerUuidThe UUID of the player that is being blocked.
protected virtual void OnUnblockPlayerResponse(const UnblockType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,const FGuid PlayerUuid)
Handles the response to a Unblock Player call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
PlayerUuidThe UUID of the player that is being unblocked.
protected virtual void OnFetchFriendForAdd(const GetFriendRelationshipType::Response & Resp,FRH_AddFriendBlock Delegate,AddFriendType::Request Request,int32 RetryEtagFailureCount)
Handles the response to a Fetch Friend For Add call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
RequestThe Request used to make the fetch friend call. -
RetryEtagFailureCountNumber of times this has failed, to determine course of action.
protected virtual void OnFetchFriendForAddNote(const GetFriendRelationshipType::Response & Resp,FRH_AddNotesBlock Delegate,AddNotesType::Request Request,int32 RetryEtagFailureCount)
Handles the response to a Fetch Friend For Add Note call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
RequestThe Request used to make the fetch friend call. -
RetryEtagFailureCountNumber of times this has failed, to determine course of action.
protected virtual void OnFetchFriendForDeleteNote(const GetFriendRelationshipType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,DeleteNotesType::Request Request,int32 RetryEtagFailureCount)
Handles the response to a Fetch Friend For Delete Note call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
RequestThe Request used to make the fetch friend call. -
RetryEtagFailureCountNumber of times this has failed, to determine course of action.
protected virtual void OnFetchFriendForRemove(const GetFriendRelationshipType::Response & Resp,FRH_GenericFriendWithUuidBlock Delegate,DeleteFriendType::Request Request,int32 RetryEtagFailureCount)
Handles the response to a Fetch Friend For Remove call.
Parameters
-
RespResponse given for the call. -
DelegateDelegate passed in for original call to respond to when call completes. -
RequestThe Request used to make the fetch friend call. -
RetryEtagFailureCountNumber of times this has failed, to determine course of action.
protected void UpdatePlatformFriends(TArray< URH_PlatformFriend * > & NewFriends)
Updates the cached Platforms friends with the new set of friends data.
Parameters
NewFriendsNew platform friend data.
protected void RemoveAllFriendsWithNoRelationships(TArray< URH_RHFriendAndPlatformFriend * > & OutArray)
Removes all friends from the cached data that have no relationship to the player the subsystem is for.
Parameters
OutArrayArray of players that were removed.
protected void PollFriendsList(const FRH_PollCompleteFunc & Delegate)
Executes a poll of the players friends list.
Parameters
DelegateCallback delegate for the poll.
protected void PollBlockedPlayers(const FRH_PollCompleteFunc & Delegate)
Executes a poll of the players blocked list.
Parameters
DelegateCallback delegate for the poll.
protected FName ExtractErrorCodeFromResponse(const FHttpResponsePtr & Response) const
Gets the error code response name from a http request.
Parameters
ResponseThe Http response to get the error from.
Returns
The error code.
protected virtual void OnReadOSSFriendsComplete(int32 LocalUserNum,bool bWasSuccessful,const FString & ListName,const FString & ErrorStr)
Handles the response from the online subsystem call to get friends.
Parameters
-
LocalUserNumController id of the local player. -
bWasSuccessfulIf the get friends call was successful. -
ListNameThe name of the list that was requested. -
ErrorStrError string if the call failed.
protected virtual void UpdateWithOSSFriends(const FString & ListName)
Updates the system with the friends from the online subsystem.
Parameters
ListNameThe list name where the friends are stored.
protected virtual void OnOSSPresenceReceived(const FUniqueNetId & UserId,const TSharedRef< FOnlineUserPresence > & NewPresence)
Handles the response from the online subsystem call to get presence.
Parameters
-
UserIdNet Id of the player the presence is for. -
NewPresenceThe presence information from the online subsystem.
typedef GetBlockedListType
Type Define for Get Blocked List calls.
typedef GetBlockedType
Type Define for Get Blocked calls.
typedef BlockType
Type Define for Block Player calls.
typedef UnblockType
Type Define for Unblock Player calls.
typedef GetFriendsListType
Type Define for Get Friends List calls.
typedef GetFriendRelationshipType
Type Define for Get Friend Relationship calls.
typedef AddFriendType
Type Define for Add Friend calls.
typedef DeleteFriendType
Type Define for Remove Friend calls.
typedef AddNotesType
Type Define for Add Friend Notes calls.
typedef DeleteNotesType
Type Define for Delete Friend Notes calls.