ProwlService.RetrieveApiKey Method

ProwlService RetrieveApiKey Method

NuGardt

Get an API key from a registration token retrieved in retrieve/token. The user must have approved your request first, or you will get an error response. This is the second/final step in fetching an API key for a user.

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 RetrieveApiKey(
	string ProviderKey,
	string Token,
	out ProwlResult Result,
	bool NoSSL = false
)

public static Exception RetrieveApiKey(
	string ProviderKey,
	string Token,
	out ProwlResult Result,
	bool NoSSL = false
)

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

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

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

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

Parameters

ProviderKey: Type: System String
Your provider API key. Required.

Token: Type: System String
The token returned from retrieve/token. Required.

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

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