ProwlService.VerifyBegin Method

ProwlService VerifyBegin 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 IAsyncResult VerifyBegin(
	Object Key,
	string ApiKey,
	AsyncCallback Callback,
	string ProviderKey = null,
	bool NoSSL = false
)

public static IAsyncResult VerifyBegin(
	Object Key,
	string ApiKey,
	AsyncCallback Callback,
	string ProviderKey = null,
	bool NoSSL = false
)

Public Shared Function VerifyBegin ( 
	Key As Object,
	ApiKey As String,
	Callback As AsyncCallback,
	Optional ProviderKey As String = Nothing,
	Optional NoSSL As Boolean = false
) As IAsyncResult

Public Shared Function VerifyBegin ( 
	Key As Object,
	ApiKey As String,
	Callback As AsyncCallback,
	Optional ProviderKey As String = Nothing,
	Optional NoSSL As Boolean = false
) As IAsyncResult

public:
static IAsyncResult^ VerifyBegin(
	Object^ Key, 
	String^ ApiKey, 
	AsyncCallback^ Callback, 
	String^ ProviderKey = nullptr, 
	bool NoSSL = false
)

public:
static IAsyncResult^ VerifyBegin(
	Object^ Key, 
	String^ ApiKey, 
	AsyncCallback^ Callback, 
	String^ ProviderKey = nullptr, 
	bool NoSSL = false
)

Parameters

Key: Type: System Object
Your own Key for tracking asynchronous calls.

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

Callback: Type: System AsyncCallback
Method to call on completion or failure.

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:

IAsyncResult
Returns an System.IAsyncResult.

Remarks