Class SendingMessage

A message sent to the server.

Inheritance

object

SendingMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: ntfy.Requests

Assembly: ntfy.dll

Syntax

public class SendingMessage

Properties

Actions

A list of actions to include in this message. Available actions include View, Broadcast and Http.

Declaration

[JsonProperty("actions", Required = Required.AllowNull, NullValueHandling = NullValueHandling.Ignore)]
public Action[]? Actions { get; set; }

Property Value

Type	Description
Action[]

Attach

A URL to send as an attachment in this message. This is an alternative to sending the file itself to the server via Filename.

Declaration

[JsonProperty("attach", Required = Required.AllowNull, NullValueHandling = NullValueHandling.Ignore)]
public Uri? Attach { get; set; }

Property Value

Type	Description
Uri

Cache

Whether to enable or disable caching for this message.

Declaration

[JsonIgnore]
public bool Cache { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidParameterException	An invalid option was parsed.

Click

The URL to open when the associated notification for this message is clicked.

Declaration

[JsonProperty("click", Required = Required.AllowNull, NullValueHandling = NullValueHandling.Ignore)]
public Uri? Click { get; set; }

Property Value

Type	Description
Uri

Delay

The delay to wait before sending the message.

Declaration

[JsonIgnore]
public Delay? Delay { set; }

Property Value

Type	Description
Delay

Email

Declaration

[JsonProperty("email", Required = Required.AllowNull, NullValueHandling = NullValueHandling.Ignore)]
public string? Email { get; set; }

Property Value

Type	Description
string

Filename

The filename of the file to include in this message. This file will be sent to the server. If you want to send a URL instead, use Attach instead.

Declaration

[JsonProperty("filename", Required = Required.AllowNull, NullValueHandling = NullValueHandling.Ignore)]
public string? Filename { get; set; }

Property Value

Type	Description
string

Firebase

Whether to enable or disable sending this message to Firebase.

Declaration

[JsonIgnore]
public bool Firebase { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidParameterException	An invalid option was parsed.

Icon

The URL to send as the associated notification's icon.

Declaration

[JsonProperty("icon", Required = Required.AllowNull, NullValueHandling = NullValueHandling.Ignore)]
public string? Icon { get; set; }

Property Value

Type	Description
string

Message

The main body of this message to show in the associated notification.

Declaration

[JsonProperty("message", Required = Required.AllowNull, NullValueHandling = NullValueHandling.Ignore)]
public string? Message { get; set; }

Property Value

Type	Description
string

Priority

The priority level of this message.

Declaration

[JsonIgnore]
public PriorityLevel? Priority { get; set; }

Property Value

Type	Description
PriorityLevel

Tags

Tags to include in the message.

Declaration

[JsonProperty("tags", Required = Required.AllowNull, NullValueHandling = NullValueHandling.Ignore)]
public string[]? Tags { get; set; }

Property Value

Type	Description
string[]

Title

The title of this message.

Declaration

[JsonProperty("title", Required = Required.AllowNull, NullValueHandling = NullValueHandling.Ignore)]
public string? Title { get; set; }

Property Value

Type	Description
string

UnifiedPush

Whether to enable or disable UnifiedPush for this message.

Declaration

[JsonIgnore]
public bool UnifiedPush { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidParameterException	An invalid option was parsed.