Search Results for

    Show / Hide Table of Contents
    View Source

    Class HealthCheckStatus

    The status returned for a health check when it performs it check TODO: This model will be used in the WebApi result so needs attributes for JSON usage

    Inheritance
    System.Object
    Namespace: Umbraco.Cms.Core.HealthChecks
    Assembly: Umbraco.Core.dll
    Syntax
    [DataContract(Name = "healthCheckStatus", Namespace = "")]
    public class HealthCheckStatus

    Constructors

    View Source

    HealthCheckStatus(String)

    Declaration
    public HealthCheckStatus(string message)
    Parameters
    Type Name Description
    System.String message

    Properties

    View Source

    Actions

    The potential actions to take (in any)

    Declaration
    [DataMember(Name = "actions")]
    public IEnumerable<HealthCheckAction> Actions { get; set; }
    Property Value
    Type Description
    IEnumerable<HealthCheckAction>
    View Source

    Description

    The status description if one is necessary

    Declaration
    [DataMember(Name = "description")]
    public string Description { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    Message

    The status message

    Declaration
    [DataMember(Name = "message")]
    public string Message { get; }
    Property Value
    Type Description
    System.String
    View Source

    ReadMoreLink

    This is optional but would allow a developer to specify a link that is shown as a "read more" button.

    Declaration
    [DataMember(Name = "readMoreLink")]
    public string ReadMoreLink { get; set; }
    Property Value
    Type Description
    System.String
    View Source

    ResultType

    The status type

    Declaration
    [DataMember(Name = "resultType")]
    public StatusResultType ResultType { get; set; }
    Property Value
    Type Description
    StatusResultType
    View Source

    View

    This is optional but would allow a developer to specify a path to an angular HTML view in order to either show more advanced information and/or to provide input for the admin to configure how an action is executed

    Declaration
    [DataMember(Name = "view")]
    public string View { get; set; }
    Property Value
    Type Description
    System.String
    • Improve this Doc
    • View Source
    In This Article
    • Constructors
      • HealthCheckStatus(String)
    • Properties
      • Actions
      • Description
      • Message
      • ReadMoreLink
      • ResultType
      • View
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX