ProwlService.Verify Method

ProwlService Verify Method

NuGardt

Verify an API key is valid. For the sake of adding a notification do not call verify first; it costs you an API call. You should only use verify to confirm an API key is valid in situations like a user entering an API key into your program. If it's not valid while posting the notification, you will get the appropriate error.

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

Syntax

C++

Copy to Clipboard Print

public static Exception Verify(
	string ApiKey,
	out ProwlResult Result,
	string ProviderKey = null,
	bool NoSSL = false
)

public static Exception Verify(
	string ApiKey,
	out ProwlResult Result,
	string ProviderKey = null,
	bool NoSSL = false
)

Public Shared Function Verify ( 
	ApiKey As String,
	<OutAttribute> ByRef Result As ProwlResult,
	Optional ProviderKey As String = Nothing,
	Optional NoSSL As Boolean = false
) As Exception

Public Shared Function Verify ( 
	ApiKey As String,
	<OutAttribute> ByRef Result As ProwlResult,
	Optional ProviderKey As String = Nothing,
	Optional NoSSL As Boolean = false
) As Exception

public:
static Exception^ Verify(
	String^ ApiKey, 
	[OutAttribute] ProwlResult^% Result, 
	String^ ProviderKey = nullptr, 
	bool NoSSL = false
)

public:
static Exception^ Verify(
	String^ ApiKey, 
	[OutAttribute] ProwlResult^% Result, 
	String^ ProviderKey = nullptr, 
	bool NoSSL = false
)

Parameters

ApiKey: Type: System String
The user's API key. A 40-byte hexadecimal string.

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

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

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