Public Member Functions | |
| Promise< EmptyResponse > | MarkRead (string id) |
| A Auth.User can have an inbox of AnnouncementView. When an announcement is created, it will be sent to all players, and will be "unread". This method will change the AnnouncementView.isRead field to true, and prevent the announcement from appearing as "new" to a Auth.User. However, the announcement is still in the player's inbox. More... | |
| Promise< EmptyResponse > | MarkRead (List< string > ids) |
| A Auth.User can have an inbox of AnnouncementView. When an announcement is created, it will be sent to all players, and will be "unread". This method will change the AnnouncementView.isRead field to true for a given set of announcements, and prevent the announcements from appearing as "new" to a Auth.User. However, the announcement is still in the player's inbox. More... | |
| Promise< EmptyResponse > | MarkDeleted (string id) |
| A Auth.User can have an inbox of AnnouncementView. This method will permanently delete an announcement from the player's inbox so that they never see it again. Be careful!, an announcement may also have rewards for the player, but if the announcement is deleted before the rewards are claimed, then the rewards are lost. Use the Claim(string) method to make sure the rewards are granted before you delete a player's announcement. Use the AnnouncementView.isClaimed field to check if the announcement has been claimed. More... | |
| Promise< EmptyResponse > | MarkDeleted (List< string > ids) |
| A Auth.User can have an inbox of AnnouncementView. This method will permanently delete a set of announcements from the player's inbox so that they never see them again. Be careful!, announcements may also have rewards for the player, but if announcements are deleted before the rewards are claimed, then the rewards are lost. Use the Claim(List<string>) method to make sure the rewards are granted before you delete player's announcements. Use the AnnouncementView.isClaimed field to check if the announcements have been claimed. More... | |
| Promise< EmptyResponse > | Claim (string id) |
| A Auth.User can have an inbox of AnnouncementView. Announcements can have rewards associated with them that the player can claim one time. These rewards are stored in the AnnouncementView.gift field, and some legacy rewards are visible in the AnnouncementView.attachments field. This method will grant the rewards to the player for one announcement. Once the rewards have been claimed, the AnnouncementView.isClaimed will be true. More... | |
| Promise< EmptyResponse > | Claim (List< string > ids) |
| A Auth.User can have an inbox of AnnouncementView. Announcements can have rewards associated with them that the player can claim one time. These rewards are stored in the AnnouncementView.gift field, and some legacy rewards are visible in the AnnouncementView.attachments field. This method will grant the rewards to the player for a set of announcements. Once the rewards have been claimed, the AnnouncementView.isClaimed will be true. More... | |
 Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< AnnouncementQueryResponse > | |
| Promise< TData > | GetCurrent (string scope="") |
| Manually fetch the available data. If the server hasn't delivered a new update, this method will not return the absolute latest data unless you pass forceRefresh as true. More... | |
Member Function Documentation
◆ Claim() [1/2]
| Promise< EmptyResponse > Beamable.Common.Api.Announcements.IAnnouncementsApi.Claim | ( | List< string > | ids | ) |
A Auth.User can have an inbox of AnnouncementView. Announcements can have rewards associated with them that the player can claim one time. These rewards are stored in the AnnouncementView.gift field, and some legacy rewards are visible in the AnnouncementView.attachments field. This method will grant the rewards to the player for a set of announcements. Once the rewards have been claimed, the AnnouncementView.isClaimed will be true.
- Parameters
-
ids A set of ids from AnnouncementViews. These should be the AnnouncementView.id field values.
Implemented in Beamable.Common.Api.Announcements.AbsAnnouncementsApi, and Beamable.Api.Announcements.AnnouncementsService.
◆ Claim() [2/2]
| Promise< EmptyResponse > Beamable.Common.Api.Announcements.IAnnouncementsApi.Claim | ( | string | id | ) |
A Auth.User can have an inbox of AnnouncementView. Announcements can have rewards associated with them that the player can claim one time. These rewards are stored in the AnnouncementView.gift field, and some legacy rewards are visible in the AnnouncementView.attachments field. This method will grant the rewards to the player for one announcement. Once the rewards have been claimed, the AnnouncementView.isClaimed will be true.
- Parameters
-
id The id of an AnnouncementView. This should be the AnnouncementView.id field.
Implemented in Beamable.Common.Api.Announcements.AbsAnnouncementsApi.
◆ MarkDeleted() [1/2]
| Promise< EmptyResponse > Beamable.Common.Api.Announcements.IAnnouncementsApi.MarkDeleted | ( | List< string > | ids | ) |
A Auth.User can have an inbox of AnnouncementView. This method will permanently delete a set of announcements from the player's inbox so that they never see them again. Be careful!, announcements may also have rewards for the player, but if announcements are deleted before the rewards are claimed, then the rewards are lost. Use the Claim(List<string>) method to make sure the rewards are granted before you delete player's announcements. Use the AnnouncementView.isClaimed field to check if the announcements have been claimed.
- Parameters
-
ids A set of ids from AnnouncementViews. These should be the AnnouncementView.id field values.
Implemented in Beamable.Common.Api.Announcements.AbsAnnouncementsApi, and Beamable.Api.Announcements.AnnouncementsService.
◆ MarkDeleted() [2/2]
| Promise< EmptyResponse > Beamable.Common.Api.Announcements.IAnnouncementsApi.MarkDeleted | ( | string | id | ) |
A Auth.User can have an inbox of AnnouncementView. This method will permanently delete an announcement from the player's inbox so that they never see it again. Be careful!, an announcement may also have rewards for the player, but if the announcement is deleted before the rewards are claimed, then the rewards are lost. Use the Claim(string) method to make sure the rewards are granted before you delete a player's announcement. Use the AnnouncementView.isClaimed field to check if the announcement has been claimed.
- Parameters
-
id The id of an AnnouncementView. This should be the AnnouncementView.id field.
Implemented in Beamable.Common.Api.Announcements.AbsAnnouncementsApi.
◆ MarkRead() [1/2]
| Promise< EmptyResponse > Beamable.Common.Api.Announcements.IAnnouncementsApi.MarkRead | ( | List< string > | ids | ) |
A Auth.User can have an inbox of AnnouncementView. When an announcement is created, it will be sent to all players, and will be "unread". This method will change the AnnouncementView.isRead field to true for a given set of announcements, and prevent the announcements from appearing as "new" to a Auth.User. However, the announcement is still in the player's inbox.
- Parameters
-
ids A set of ids from AnnouncementViews. These should be the AnnouncementView.id field values.
Implemented in Beamable.Common.Api.Announcements.AbsAnnouncementsApi, and Beamable.Api.Announcements.AnnouncementsService.
◆ MarkRead() [2/2]
| Promise< EmptyResponse > Beamable.Common.Api.Announcements.IAnnouncementsApi.MarkRead | ( | string | id | ) |
A Auth.User can have an inbox of AnnouncementView. When an announcement is created, it will be sent to all players, and will be "unread". This method will change the AnnouncementView.isRead field to true, and prevent the announcement from appearing as "new" to a Auth.User. However, the announcement is still in the player's inbox.
- Parameters
-
id The id of an AnnouncementView. This should be the AnnouncementView.id field.
Implemented in Beamable.Common.Api.Announcements.AbsAnnouncementsApi.
The documentation for this interface was generated from the following file:
- com.beamable/Common/Runtime/Api/Announcements/IAnnouncementsApi.cs
