Class ContentDetail

Content detail

Inheritance

object

ContentDetail

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class ContentDetail

Properties

Activity

Activity information: dynamically mapped from configured metadata fields or from audit information if no mapping is configured.

Declaration

[JsonProperty("activity", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public Activity Activity { get; set; }

Property Value

Activity

Audit

Audit information.

Declaration

[JsonProperty("audit", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public UserAuditDetail Audit { get; set; }

Property Value

UserAuditDetail

BrokenIndirectReferenceIds

All the IDs of the indirectly referenced list items (tagboxes) that do not exist in the system.
They are referenced list items that reference at least a list item that do not exist in the system.

Declaration

[JsonProperty("brokenIndirectReferenceIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Obsolete("No longer set by the system, will be removed in the future.")]
public ICollection<string> BrokenIndirectReferenceIds { get; set; }

Property Value

ICollection<string>

BrokenReferenceIds

All the IDs of the referenced list items (tagboxes) that do not exist in the system.

Declaration

[JsonProperty("brokenReferenceIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> BrokenReferenceIds { get; set; }

Property Value

ICollection<string>

BrokenRelationTargetIds

All the IDs of the contents or list items target of a relation that do not exist in the system.

Declaration

[JsonProperty("brokenRelationTargetIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> BrokenRelationTargetIds { get; set; }

Property Value

ICollection<string>

Content

The content data of the content. It's an object of dynamic metadata whose structure is defined in the Content schema identified.
by the ContentSchemaId property.

Declaration

[JsonProperty("content", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public object Content { get; set; }

Property Value

object

ContentPermissionSetIds

An optional list of content permission set IDs which control content permissions. These permissions control content accessibility for the users that do not own the content.

Declaration

[JsonProperty("contentPermissionSetIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> ContentPermissionSetIds { get; set; }

Property Value

ICollection<string>

ContentRights

List of content rights the user has on this content

Declaration

[JsonProperty("contentRights", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<ContentRight> ContentRights { get; set; }

Property Value

ICollection<ContentRight>

ContentSchemaId

The ID of the content schema. The SchemaType of the specified schema must be Content.
The schema specifies the structure of the Content dictionary.

Declaration

[JsonProperty("contentSchemaId", Required = Required.Always)]
[Required]
public string ContentSchemaId { get; set; }

Property Value

string

ContentType

Content type.

Declaration

[JsonProperty("contentType", Required = Required.Always)]
[Required(AllowEmptyStrings = true)]
[JsonConverter(typeof(StringEnumConverter))]
public ContentType ContentType { get; set; }

Property Value

ContentType

DisplayContentId

The id of related DisplayContent

Declaration

[JsonProperty("displayContentId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string DisplayContentId { get; set; }

Property Value

string

DisplayContentOutputs

The Outputs generated from the display content.

Declaration

[JsonProperty("displayContentOutputs", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<Output> DisplayContentOutputs { get; set; }

Property Value

ICollection<Output>

DisplayValues

Contains language specific display values. They are calculated values based on the template stored in the Content schema DisplayPatterns property.

Declaration

[JsonProperty("displayValues", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public DisplayValueDictionary DisplayValues { get; set; }

Property Value

DisplayValueDictionary

HistoricVersionCount

The number of historized versions of the content. Contains null if
(i) not requested by using HistoricVersionCount resolve behavior,
(ii) user lacks ManageHistoricVersions right on the content,
(iii) user lacks ManageContent user right,
(iv) historic versioning is disabled or
(v) content is a virtual item (ContentType is Virtual).

Declaration

[JsonProperty("historicVersionCount", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public int? HistoricVersionCount { get; set; }

Property Value

int?

Id

The content ID.

Declaration

[JsonProperty("id", Required = Required.Always)]
[Required]
public string Id { get; set; }

Property Value

string

LayerSchemaIds

An optional list of IDs of the schemas that form the layers of the content.
The SchemaType of the specified schemas must be Layer.

Declaration

[JsonProperty("layerSchemaIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> LayerSchemaIds { get; set; }

Property Value

ICollection<string>

LifeCycle

The actual lifecycle value of the content. Becomes Inactive when the content is deleted.

Declaration

[JsonProperty("lifeCycle", Required = Required.Always)]
[Required(AllowEmptyStrings = true)]
[JsonConverter(typeof(StringEnumConverter))]
public LifeCycle LifeCycle { get; set; }

Property Value

LifeCycle

Metadata

The metadata belonging to the layers of the content. It's a dictionary of dynamic metadata whose structure is defined in the Layer schemas identified
by the LayerSchemaIds property.

Declaration

[JsonProperty("metadata", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<string, object> Metadata { get; set; }

Property Value

IDictionary<string, object>

Outputs

The Outputs generated from the content. They identifies the rendered files generated by the system.
They are available only for file base contents, and they depends on the output formats configured in the system.

Declaration

[JsonProperty("outputs", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<Output> Outputs { get; set; }

Property Value

ICollection<Output>

Owner

The resolved owner.

Declaration

[JsonProperty("owner", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public User Owner { get; set; }

Property Value

User

OwnerTokenId

The owner token ID. Defines the content owner.

Declaration

[JsonProperty("ownerTokenId", Required = Required.Always)]
[Required]
public string OwnerTokenId { get; set; }

Property Value

string

Methods

AsContentItem<T>()

Creates a typed content item wrapped in a ContentItem container.

Declaration

public ContentItem<T> AsContentItem<T>()

Returns

ContentItem<T> The content item.

Type Parameters

T The content item type.

ContentAs<T>()

Returns content deserialized into the requested class

Declaration

public T ContentAs<T>()

Returns

T Deserialized content

Type Parameters

T Content type

FromJson(string)

Declaration

public static ContentDetail FromJson(string data)

Parameters

string data

Returns

ContentDetail

GetFileMetadata()

Gets the content detail's file metadata.

Declaration

public FileMetadata GetFileMetadata()

Returns

FileMetadata The file metadata.

HasLayer(string)

Tests if a layer is present in Metadata dictionary.

Declaration

public bool HasLayer(string schemaId)

Parameters

string schemaId OSchema ID of the layer within the metadata dictionary.

Returns

bool True if the layer with the provided schema ID is present in metadata dictionary, false otherwise.

HasLayer<T>()

Tests if a layer is present in Metadata dictionary.

Declaration

public bool HasLayer<T>()

Returns

bool True if the layer representing the type T is present in metadata dictionary, false otherwise.

Type Parameters

T Type representing the layer

Layer(string)

Returns layer from Metadata based on a schema ID.

Declaration

public JObject Layer(string schemaId)

Parameters

string schemaId Schema ID of the layer within the metadata dictionary.

Returns

JObject Layer metadata

LayerDisplayValues(string)

Deserializes the values for the specified layer and gets the display values.

Declaration

public DisplayValueDictionary LayerDisplayValues(string schemaId)

Parameters

string schemaId Layer schema ID

Returns

DisplayValueDictionary Deserialized display values for the layer

LayerDisplayValues<T>()

Deserializes the values for the specified layer and gets the display values.

Declaration

public DisplayValueDictionary LayerDisplayValues<T>()

Returns

DisplayValueDictionary Deserialized display values for the layer

Type Parameters

T Type representing the layer

Layer<T>(string)

Returns layer from Metadata deserialized into a custom type.

Declaration

public T Layer<T>(string schemaId = null)

Parameters

string schemaId Optional ID of the layer within the metadata dictionary. If not provided, it will be determined by schema ID defined in PictureparkSchemaAttribute on the layer class (if applied) or the name of the type. Anonymous classes are naturally not supported.

Returns

T Layer metadata

Type Parameters

T Type representing the layer

ToJson()

Declaration

public string ToJson()

Returns

string