Class PluginStatus 

[Obfuscation(Exclude = true, ApplyToMembers = true)]
[Serializable]
public class PluginStatus
Inheritance
System.Object
PluginStatus
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: HomeSeer.PluginSdk
Assembly: PluginSdk.dll

Represents the current operational state of a HomeSeer plugin.


Remarks

This is the expected return type when HomeSeer calls a plugin's implementation of OnStatusCheck()

Examples
public void BeforeReturnStatus() {
    //Analyze the current state of the plugin
    //...
    //The plugin is operating as expected
    Status = PluginStatus.Ok();
}

Constructors

View Source

PluginStatus(PluginStatus.EPluginStatus, String)

Creates a new PluginStatus with the specified PluginStatus.EPluginStatus and status text

Declaration
public PluginStatus(PluginStatus.EPluginStatus status, string statusText)
Parameters
Type Name Description
PluginStatus.EPluginStatus status

The PluginStatus.EPluginStatus representing the current state of the plugin
System.String statusText

A detailed explanation of the status
Exceptions
Type Condition
System.ArgumentNullException

Thrown if no status text was supplied when the status is not OK

Properties

View Source

Status

The status of the plugin as an PluginStatus.EPluginStatus

Declaration
public PluginStatus.EPluginStatus Status { get; }
Property Value
Type Description
PluginStatus.EPluginStatus
View Source

StatusText

A detailed explanation of the status of the plugin

Declaration
public string StatusText { get; }
Property Value
Type Description
System.String

Methods

View Source

Critical(String)

Creates a new PluginStatus with the status of Critical and the specified description

Declaration
public static PluginStatus Critical(string statusText)
Parameters
Type Name Description
System.String statusText

A detailed explanation of the status
Returns
Type Description
PluginStatus

A PluginStatus with a status of Critical
View Source

Fatal(String)

Creates a new PluginStatus with the status of Fatal and the specified description

Declaration
public static PluginStatus Fatal(string statusText)
Parameters
Type Name Description
System.String statusText

A detailed explanation of the status
Returns
Type Description
PluginStatus

A PluginStatus with a status of Fatal
View Source

Info(String)

Creates a new PluginStatus with the status of Info and the specified description

Declaration
public static PluginStatus Info(string statusText)
Parameters
Type Name Description
System.String statusText

A detailed explanation of the status
Returns
Type Description
PluginStatus

A PluginStatus with a status of Info
View Source

Ok()

Creates a new PluginStatus of OK

Declaration
public static PluginStatus Ok()
Returns
Type Description
PluginStatus

A PluginStatus with a status of OK
View Source

Warning(String)

Creates a new PluginStatus with the status of Warning and the specified description

Declaration
public static PluginStatus Warning(string statusText)
Parameters
Type Name Description
System.String statusText

A detailed explanation of the status
Returns
Type Description
PluginStatus

A PluginStatus with a status of Warning