Struct AlertKey

Key for an alert which is unique (for equality and hashcode purposes) w.r.t category semantics. I.e., entirely defined by the category, if a category was specified, otherwise falls back to the id.

Namespace: Content.Shared.Alert

Assembly: Content.Shared.dll

Syntax

public struct AlertKey

Constructors

| Improve this Doc View Source

AlertKey(Nullable<AlertType>, Nullable<AlertCategory>)

Declaration

public AlertKey(AlertType? alertType, AlertCategory? alertCategory)

Parameters

Type	Name	Description
System.Nullable<AlertType>	alertType
System.Nullable<AlertCategory>	alertCategory

Fields

| Improve this Doc View Source

AlertCategory

Declaration

public readonly AlertCategory? AlertCategory

Field Value

Type	Description
System.Nullable<AlertCategory>

Properties

| Improve this Doc View Source

AlertType

Declaration

public AlertType? AlertType { get; }

Property Value

Type	Description
System.Nullable<AlertType>

Methods

| Improve this Doc View Source

Equals(AlertKey)

Declaration

public bool Equals(AlertKey other)

Parameters

Type	Name	Description
AlertKey	other

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

Equals(Nullable<Object>)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
System.Nullable<System.Object>	obj

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

ForCategory(AlertCategory)

Declaration

public static AlertKey ForCategory(AlertCategory category)

Parameters

Type	Name	Description
AlertCategory	category	alert category, must not be null

Returns

Type	Description
AlertKey	An alert key for the provided alert category. This must only be used for queries and never storage, as it is lacking an alert type.

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32