Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.OnlineNewsInterface

Modifiers
dependson ( OnlineSubsystem )

This interface provides functions for reading game specific news and announcements

Engine.OnlineNewsInterface

Delegates Summary
delegate OnReadContentAnnouncementsCompleted (bool bWasSuccessful)
delegate OnReadGameNewsCompleted (bool bWasSuccessful)

Functions Summary
function AddReadContentAnnouncementsCompletedDelegate (delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate)
function AddReadGameNewsCompletedDelegate (delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate)
function ClearReadContentAnnouncementsCompletedDelegate (delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate)
function ClearReadGameNewsCompletedDelegate (delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate)
functionstring GetContentAnnouncements (byte LocalUserNum)
functionstring GetGameNews (byte LocalUserNum)
functionbool ReadContentAnnouncements (byte LocalUserNum)
functionbool ReadGameNews (byte LocalUserNum)


Delegates Detail

OnReadContentAnnouncementsCompleted Source code

delegate OnReadContentAnnouncementsCompleted ( bool bWasSuccessful )
Delegate used in notifying the UI/game that the content announcements read operation completed
@param bWasSuccessful true if the read completed ok, false otherwise

OnReadGameNewsCompleted Source code

delegate OnReadGameNewsCompleted ( bool bWasSuccessful )
Delegate used in notifying the UI/game that the news read operation completed
@param bWasSuccessful true if the read completed ok, false otherwise


Functions Detail

AddReadContentAnnouncementsCompletedDelegate Source code

function AddReadContentAnnouncementsCompletedDelegate ( delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate )
Sets the delegate used to notify the gameplay code that content announcements reading has completed
@param ReadContentAnnouncementsDelegate the delegate to use for notifications

AddReadGameNewsCompletedDelegate Source code

function AddReadGameNewsCompletedDelegate ( delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate )
Sets the delegate used to notify the gameplay code that news reading has completed
@param ReadGameNewsDelegate the delegate to use for notifications

ClearReadContentAnnouncementsCompletedDelegate Source code

function ClearReadContentAnnouncementsCompletedDelegate ( delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate )
Removes the specified delegate from the notification list
@param ReadContentAnnouncementsDelegate the delegate to use for notifications

ClearReadGameNewsCompletedDelegate Source code

function ClearReadGameNewsCompletedDelegate ( delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate )
Removes the specified delegate from the notification list
@param ReadGameNewsDelegate the delegate to use for notifications

GetContentAnnouncements Source code

function string GetContentAnnouncements ( byte LocalUserNum )
Returns the game specific content announcements from the cache
@param LocalUserNum the local user the content announcements is being read for
@return an empty string if no data was read, otherwise the contents of the read

GetGameNews Source code

function string GetGameNews ( byte LocalUserNum )
Returns the game specific news from the cache
@param LocalUserNum the local user the news is being read for
@return an empty string if no news was read, otherwise the contents of the read

ReadContentAnnouncements Source code

function bool ReadContentAnnouncements ( byte LocalUserNum )
Reads the game specific content announcements from the online subsystem
@param LocalUserNum the local user the request is for
@return true if the async task was successfully started, false otherwise

ReadGameNews Source code

function bool ReadGameNews ( byte LocalUserNum )
Reads the game specific news from the online subsystem
@param LocalUserNum the local user the news is being read for
@return true if the async task was successfully started, false otherwise


Defaultproperties

defaultproperties
{
   Name="Default__OnlineNewsInterface"
   ObjectArchetype=Interface'Core.Default__Interface'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:40.165 - Created with UnCodeX