ProwlService.AddNotification Method

ProwlService AddNotification Method

NuGardt

Add a notification for a particular user. You must provide either event or description or both.

Namespace: NuGardt.Prowl.API
Assembly: NuGardt.Prowl.API (in NuGardt.Prowl.API.dll) Version: 1.0.0.1 (1.0.0.1)

Syntax

public static Exception AddNotification(
	string ApiKey,
	string Application,
	string Event,
	string Description,
	out ProwlResult Result,
	string ProviderKey = null,
	eProwlPriority Priority = eProwlPriority.Normal,
	string URL = null,
	bool NoSSL = false
)

public static Exception AddNotification(
	string ApiKey,
	string Application,
	string Event,
	string Description,
	out ProwlResult Result,
	string ProviderKey = null,
	eProwlPriority Priority = eProwlPriority.Normal,
	string URL = null,
	bool NoSSL = false
)

Public Shared Function AddNotification ( 
	ApiKey As String,
	Application As String,
	Event As String,
	Description As String,
	<OutAttribute> ByRef Result As ProwlResult,
	Optional ProviderKey As String = Nothing,
	Optional Priority As eProwlPriority = eProwlPriority.Normal,
	Optional URL As String = Nothing,
	Optional NoSSL As Boolean = false
) As Exception

Public Shared Function AddNotification ( 
	ApiKey As String,
	Application As String,
	Event As String,
	Description As String,
	<OutAttribute> ByRef Result As ProwlResult,
	Optional ProviderKey As String = Nothing,
	Optional Priority As eProwlPriority = eProwlPriority.Normal,
	Optional URL As String = Nothing,
	Optional NoSSL As Boolean = false
) As Exception

public:
static Exception^ AddNotification(
	String^ ApiKey, 
	String^ Application, 
	String^ Event, 
	String^ Description, 
	[OutAttribute] ProwlResult^% Result, 
	String^ ProviderKey = nullptr, 
	eProwlPriority Priority = eProwlPriority::Normal, 
	String^ URL = nullptr, 
	bool NoSSL = false
)

public:
static Exception^ AddNotification(
	String^ ApiKey, 
	String^ Application, 
	String^ Event, 
	String^ Description, 
	[OutAttribute] ProwlResult^% Result, 
	String^ ProviderKey = nullptr, 
	eProwlPriority Priority = eProwlPriority::Normal, 
	String^ URL = nullptr, 
	bool NoSSL = false
)

Parameters

ApiKey: Type: System String
API keys separated by commas. Each API key is a 40-byte hexadecimal string. When using multiple API keys, you will only get a failure response if all API keys are not valid.

Application: Type: System String
The name of your application or the application generating the event.

Event: Type: System String
The name of the event or subject of the notification.

Description: Type: System String
A description of the event, generally terse. [10000]

Result: Type: NuGardt.Prowl.API ProwlResult
Contains result details if applicable.

ProviderKey (Optional): Type: System String
Optional (Default: Nothing). Your provider API key. Only necessary if you have been whitelisted. [40]

Priority (Optional): Type: NuGardt.Prowl.API eProwlPriority
Optional (Default: eProwlPriority.Normal). Default value of 0 if not provided. An integer value ranging [-2, 2] representing: -2 = Very Low -1 = Moderate 0 = Normal 1 = High 2 = Emergency Emergency priority messages may bypass quiet hours according to the user's settings.

URL (Optional): Type: System String
Optional. Requires Prowl 1.2 The URL which should be attached to the notification. This will trigger a redirect when launched, and is viewable in the notification list.

NoSSL (Optional): Type: System Boolean
Optional (Default: False). Call the query without utilizing SSL (encryption).

Return Value

Type:

Exception
Return an System.Exception if an error occurred otherwise Nothing.

Remarks