PageTopicViewModel.cs

/*==============================================================================================================================
| Author        Ignia, LLC
| Client        Ignia, LLC
| Project       Topics Library
\=============================================================================================================================*/

namespace OnTopic.ViewModels {

  /*============================================================================================================================
  | VIEW MODEL: PAGE TOPIC
  \---------------------------------------------------------------------------------------------------------------------------*/
  /// <summary>
  ///   Provides a strongly-typed model for feeding views with information about a <c>Page</c> topic.
  /// </summary>
  /// <remarks>
  ///   Typically, view models should be created as part of the presentation layer. The <see cref="Models"/> namespace contains
  ///   default implementations that can be used directly, used as base classes, or overwritten at the presentation level. They
  ///   are supplied for convenience to model factory default settings for out-of-the-box content types.
  /// </remarks>
  public record PageTopicViewModel: TopicViewModel, INavigableTopicViewModel {

    /*==========================================================================================================================
    | CONSTRUCTOR
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Initializes a new <see cref="PageTopicViewModel"/> with an <paramref name="attributes"/> dictionary.
    /// </summary>
    /// <param name="attributes">An <see cref="AttributeDictionary"/> of attribute values.</param>
    public PageTopicViewModel(AttributeDictionary attributes): base(attributes) {
      Contract.Requires(attributes, nameof(attributes));
      ShortTitle                = attributes.GetValue(nameof(ShortTitle));
      Subtitle                  = attributes.GetValue(nameof(Subtitle));
      MetaTitle                 = attributes.GetValue(nameof(MetaTitle));
      MetaDescription           = attributes.GetValue(nameof(MetaDescription));
      MetaKeywords              = attributes.GetValue(nameof(MetaKeywords));
      NoIndex                   = attributes.GetBoolean(nameof(NoIndex))?? NoIndex;
      Body                      = attributes.GetValue(nameof(Body));
    }

    /// <summary>
    ///   Initializes a new <see cref="PageTopicViewModel"/> with no parameters.
    /// </summary>
    public PageTopicViewModel() { }

    /*==========================================================================================================================
    | SHORT TITLE
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Provides a short title to be used in the navigation, for cases where the normal title is too long.
    /// </summary>
    public string? ShortTitle { get; init; }

    /*==========================================================================================================================
    | SUBTITLE
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Provides an optional subtitle which will typically be displayed under the title.
    /// </summary>
    public string? Subtitle { get; init; }

    /*==========================================================================================================================
    | META TITLE
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Provides an optional title to be used in page's metadata, if it differs from the <see cref="TopicViewModel.Title"/>.
    /// </summary>
    public string? MetaTitle { get; init; }

    /*==========================================================================================================================
    | META DESCRIPTION
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <inheritdoc />
    public string? MetaDescription { get; init; }

    /*==========================================================================================================================
    | META KEYWORDS
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <inheritdoc />
    public string? MetaKeywords { get; init; }

    /*==========================================================================================================================
    | META KEYWORDS
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Determines whether or not search engines are expected to index the page.
    /// </summary>
    public bool? NoIndex { get; init; }

    /*==========================================================================================================================
    | BODY
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Provides the primary content for the page, which is typically in HTML format.
    /// </summary>
    public string? Body { get; init; }

  } //Class
} //Namespace