View Source

Class PublishableVariantResponseModelBase

Base class for publishable variant response models, providing flag support, publish state, and scheduling information.

Inheritance

object

VariantModelBase

VariantResponseModelBase

Namespace: Umbraco.Cms.Api.Management.ViewModels.Content

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public abstract class PublishableVariantResponseModelBase : VariantResponseModelBase, IHasCultureAndSegment, IHasFlags

Constructors

PublishableVariantResponseModelBase()

Declaration

protected PublishableVariantResponseModelBase()

Properties

Flags

Gets the collection of flag for the entity.

Declaration

public IEnumerable<FlagModel> Flags { get; set; }

Property Value

Type	Description
IEnumerable<FlagModel>

Id

Gets the unique identifier for the entity.

Declaration

public Guid Id { get; }

Property Value

Type	Description
Guid

PublishDate

Gets or sets the date the variant was published.

Declaration

public DateTimeOffset? PublishDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

ScheduledPublishDate

Gets or sets the scheduled publish date for the variant.

Declaration

public DateTimeOffset? ScheduledPublishDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

ScheduledUnpublishDate

Gets or sets the scheduled unpublish date for the variant.

Declaration

public DateTimeOffset? ScheduledUnpublishDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

State

Gets or sets the publish state of the variant.

Declaration

public PublishableVariantState State { get; set; }

Property Value

Type	Description
PublishableVariantState

Methods

AddFlag(string)

Adds a flag to the entity with the specified alias.

Declaration

public void AddFlag(string alias)

Parameters

Type	Name	Description
string	alias

RemoveFlag(string)

Removes a flag from the entity with the specified alias.

Declaration

public void RemoveFlag(string alias)

Parameters

Type	Name	Description
string	alias