Beamable SDK
Public Member Functions | Public Attributes | List of all members
Beamable.Player.Announcement Class Reference

Public Member Functions

Promise Read ()
 Mark the announcement as "read", so that the IsRead becomes true. More...
 
Promise Claim ()
 Claim the rewards associated with the announcement. An announcement can only be claimed once, and then the IsClaimed field will be true. More...
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Public Attributes

string Id
 The id of the announcement
 
string Title
 The title of the announcement
 
string Channel
 The channel of the announcement
 
string Body
 The main body and message of the announcement
 
bool IsRead
 True when the player has marked the announcement as read. Use the Read method.
 
bool IsClaimed
 True when the player has claimed the associated rewards with an announcement. Use the Claim method.
 
bool IsIgnored
 

Member Function Documentation

◆ Claim()

Promise Beamable.Player.Announcement.Claim ( )

Claim the rewards associated with the announcement. An announcement can only be claimed once, and then the IsClaimed field will be true.

Returns
A Promise representing the work.

◆ Read()

Promise Beamable.Player.Announcement.Read ( )

Mark the announcement as "read", so that the IsRead becomes true.

Returns
A Promise representing the work.

The documentation for this class was generated from the following file: