IOnlinePresence

Syntax

class IOnlinePresence

Remarks

Interface class for getting and setting rich presence information.

Variables

Name Description

Public variable

FOnPresenceArra ...

 

OnPresenceArrayUpdatedDelegates

Delegate executed when the array of presence data for a user changes.

Public variable

FOnPresenceRece ...

 

OnPresenceReceivedDelegates

Delegate executed when new presence data is available for a user.

Destructors

Name Description

Public function Virtual

~IOnlinePresence()

Virtual destructor to force proper child cleanup

Functions

Name Description

Public function Virtual

FDelegateHan ...

 

AddOnPresenceArrayUpdatedDelegate_Handle

(
    const FOnPresenceArrayUpdatedDelega ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPresenceReceivedDelegate_Handle

(
    const FOnPresenceReceivedDelegate &...
)

Public function Virtual

void

 

ClearOnPresenceArrayUpdatedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPresenceArrayUpdatedDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnPresenceReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPresenceReceivedDelegates

(
    void* Object
)

Public function

EOnlineCache ...

 

GetCachedPresence

(
    const FUniqueNetId & User,
    TSharedPtr < FOnlineUserPresence >&...
)

Gets the cached presence information for a user.

Public function

EOnlineCache ...

 

GetCachedPresenceForApp

(
    const FUniqueNetId & LocalUserId,
    const FUniqueNetId & User,
    const FString & AppId,
    TSharedPtr < FOnlineUserPresence >&...
)

Gets the cached presence information for a user.

Public function

void

 

QueryPresence

(
    const FUniqueNetId & User,
    const FOnPresenceTaskCompleteDelega ...
)

Starts an async operation that will update the cache with presence data from all users in the Users array.

Public function

void

 

SetPresence

(
    const FUniqueNetId & User,
    const FOnlineUserPresenceStatus & S...,
    const FOnPresenceTaskCompleteDelega ...
)

Starts an async task that sets presence information for the user.

Public function Virtual

void

 

TriggerOnPresenceArrayUpdatedDelegates

(
    const FUniqueNetId & Param1,
    const TArray < TSharedRef < FOnlineUs ...
)

Public function Virtual

void

 

TriggerOnPresenceReceivedDelegates

(
    const FUniqueNetId & Param1,
    const TSharedRef < FOnlineUserPresen ...
)

Typedefs

Name

Description

FOnPresenceTaskCompleteDelegate

Delegate executed when setting or querying presence for a user has completed.

References