Beamable SDK
Public Member Functions | Public Attributes | Properties | Events | List of all members
Beamable.Editor.Content.Models.ContentItemDescriptor Class Reference

Public Member Functions

 ContentItemDescriptor (IContentObject content, ContentTypeDescriptor typeDescriptor, string assetPath)
 
 ContentItemDescriptor (LocalContentManifestEntry entry, ContentTypeDescriptor typeDescriptor)
 
 ContentItemDescriptor (ManifestReferenceSuperset entry, ContentTypeDescriptor typeDescriptor)
 
void EnrichWithServerData (ManifestReferenceSuperset reference)
 
void EnrichWithLocalData (IContentObject content, string assetPath)
 
void EnrichWithLocalData (LocalContentManifestEntry entry)
 
void EnrichWithNoServerData ()
 
void EnrichWithNoLocalData ()
 
IEnumerable< ContentTagDescriptorGetAllTags ()
 
IEnumerable< string > GetValidationErrors ()
 
LocalContentManifestEntry GetLocalContent ()
 
IContentObject GetContent ()
 
ManifestReferenceSuperset GetServerData ()
 
void EnrichWithValidationErrors (List< ContentException > exceptions)
 
void EnrichWithNoValidationErrors ()
 
void ForceRename ()
 

Public Attributes

ContentValidationStatus ValidationStatus
 
string AssetPathShort
 A display version of the asset path that is relative to the data dir, and removes the asset file extension. More...
 
HashSet< string > AllTags => new HashSet<string>(GetAllTags().Select(x => x.Tag))
 
string Id => $"{ContentType.TypeName}.{Name}"
 

Properties

string? Name [get, set]
 
ContentTypeDescriptor ContentType [get]
 
ContentModificationStatus? Status [get]
 
string AssetPath [get]
 
HashSet< string > LocalTags [get]
 
HashSet< string > ServerTags [get]
 
HostStatus LocalStatus [get]
 
HostStatus ServerStatus [get]
 

Events

Action< ContentItemDescriptorOnRenamed
 Invoked when name change is requested. More...
 
Action OnRenameRequested
 Invoked when the name should be changed by a user More...
 
Action< ContentItemDescriptorOnEnriched
 Invoked when any change is made More...
 

Member Data Documentation

◆ AssetPathShort

string Beamable.Editor.Content.Models.ContentItemDescriptor.AssetPathShort
Initial value:
=>
string.IsNullOrEmpty(AssetPath)
? ""
: Path.GetDirectoryName(AssetPath)?.Substring(BeamableConstants.DATA_DIR.Length + 1) ?? ""

A display version of the asset path that is relative to the data dir, and removes the asset file extension.

◆ ValidationStatus

ContentValidationStatus Beamable.Editor.Content.Models.ContentItemDescriptor.ValidationStatus
Initial value:
=> _validationExceptions?.Count > 0
? ContentValidationStatus.INVALID
: ContentValidationStatus.VALID

Event Documentation

◆ OnEnriched

Action<ContentItemDescriptor> Beamable.Editor.Content.Models.ContentItemDescriptor.OnEnriched

Invoked when any change is made

◆ OnRenamed

Action<ContentItemDescriptor> Beamable.Editor.Content.Models.ContentItemDescriptor.OnRenamed

Invoked when name change is requested.

◆ OnRenameRequested

Action Beamable.Editor.Content.Models.ContentItemDescriptor.OnRenameRequested

Invoked when the name should be changed by a user


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