This type defines a Beamable ContentObject subclass for the AnnouncementsService. More...
Inheritance diagram for Beamable.Common.Announcements.AnnouncementContent:
Collaboration diagram for Beamable.Common.Announcements.AnnouncementContent:
Public Attributes | |
| string | channel = "main" |
| The channel is similar to an inbox in email. You can use whatever value you like. Common examples might be "Primary", "Advertising", or "Seasonal". | |
| string | title = "title" |
| The title is similar to the subject line of an email. | |
| string | summary = "summary" |
| A brief description of the announcement. | |
| string | body = "body" |
| The main content of the announcement | |
| OptionalString | startDate |
| The startDate, defined as UTC, specifies when the announcement becomes available for players to see. If no startDate is specified, the announcement will become visible immediately | |
| OptionalString | endDate |
| The endDate, defined as UTC, specifies when the announcement stops being available for players to see. If no endDate is specified, the announcement will be visible forever | |
| List< AnnouncementAttachment > | attachments |
| A set of AnnouncementAttachment that the player may claim. This field will be removed in the future, and entirely replaced by the gift field. | |
| AnnouncementPlayerRewards | gift |
| A AnnouncementPlayerRewards contains the rewards that a player claim for this announcement. Please use this field instead of the attachments field. | |
| OptionalStats | statRequirements |
| If specified, stat requirements will limit the audience of this announcement based on player stats. | |
| OptionalSerializableDictionaryStringToString | clientData |
| ClientData is a general purpose string to string key value pair system that you can use to add arbitrary metadata to your announcements. | |
Additional Inherited Members | |
 Public Member Functions inherited from Beamable.Common.Content.ContentObject | |
| void | SetIdAndVersion (string id, string version) |
| Set the &id and &version More... | |
| void | SetManifestID (string manifestID) |
| Set the Manifest Id More... | |
| ContentObject | SetContentName (string newContentName) |
| Set the name of the ContentObject More... | |
| void | BroadcastUpdate () |
| Broadcast an updated changed of the ContentObject field values | |
| virtual void | Validate (IValidationContext ctx) |
Validate this ContentObject. More... | |
| bool | HasValidationErrors (IValidationContext ctx, out List< string > errors) |
| Determines if the ContentObject has Validation Errors More... | |
| bool | HasValidationExceptions (IValidationContext ctx, out List< ContentException > exceptions) |
| Determines if the ContentObject has Validation Exceptions More... | |
| List< ContentValidationException > | GetMemberValidationErrors (IValidationContext ctx) |
| Gets list of the ContentObject has Member Validation Errors | |
| string | ToJson () |
| Converts the ContentObject to Json More... | |
| Static Public Member Functions inherited from Beamable.Common.Content.ContentObject | |
| static string | GetContentTypeName (Type contentType) |
| Get the TypeName of the ContentObject More... | |
| static string | GetContentType< TContent > () |
| Get the type of the ContentObject More... | |
| static TContent | Make< TContent > (string name) |
| Make an instance of the ContentObject More... | |
| Static Public Attributes inherited from Beamable.Common.Content.ContentObject | |
| const string | TooltipNotFoundDebugFallback1a = "(No Tooltip)" |
| Properties inherited from Beamable.Common.Content.ContentObject | |
| string | ContentVersion [get] |
| string | ContentName [get] |
| The name of the ContentObject | |
| string | ContentType [get] |
| The type of the ContentObject | |
| string | Id [get] |
| The id of the ContentObject | |
| string | ManifestID [get] |
| The Manifest Id | |
| string | Version [get] |
| The version of the ContentObject | |
| string[]?? | Tags [getset] |
| The tags of the ContentObject | |
| Properties inherited from Beamable.Common.Content.IContentObject | |
| string | Id [get] |
| The id. A content id is a dot separated string. The right most part is the name of the content. Every part to the left of the name denotes the type of the content. | |
| string | Version [get] |
| The version | |
| string[] | Tags [get] |
| The tags | |
| string | ManifestID [get] |
| Events inherited from Beamable.Common.Content.ContentObject | |
| ContentDelegate | OnChanged |
| Invoked after ContentObject field values change | |
Detailed Description
This type defines a Beamable ContentObject subclass for the AnnouncementsService.
Related Links
- See Beamable.Common.Content.ContentObject script reference
- See Beamable.Api.Announcements.AnnouncementsService script reference
The documentation for this class was generated from the following file:
- com.beamable/Common/Runtime/Modules/Announcements/AnnouncementContent.cs
