C# Class PodioAPI.Services.HookService

Mostrar archivo Open project: podio/podio-dotnet

Public Methods

Method	Description
CreateHook ( string refType, int refId, string externalURL, string type ) : Task	Create a new hook on the given object. See the area for details. Podio API Reference: https://developers.podio.com/doc/hooks/create-hook-215056
DeleteHook ( int hookId ) : Task	Deletes the hook with the given id. Podio API Reference: https://developers.podio.com/doc/hooks/delete-hook-215291
GetHooks ( string refType, int refId ) : Task>	Returns the hooks on the object. Podio API Reference: https://developers.podio.com/doc/hooks/get-hooks-215285
HookService ( Podio currentInstance ) : System.Collections.Generic
ValidateHookVerification ( int hookId, string code ) : Task	Validates the hook using the code received from the verify call. On successful validation the hook will become active. Podio API Reference: https://developers.podio.com/doc/hooks/validate-hook-verification-215241
Verify ( int hookId ) : Task	Request the hook to be validated. This will cause the hook to send a request to the URL with the parameter "type" set to "hook.verify" and "code" set to the verification code. The endpoint must then call the validate method with the code to complete the verification. Podio API Reference: https://developers.podio.com/doc/hooks/request-hook-verification-215232

Method Details

CreateHook() public method

Create a new hook on the given object. See the area for details.

Podio API Reference: https://developers.podio.com/doc/hooks/create-hook-215056

public CreateHook ( string refType, int refId, string externalURL, string type ) : Task
refType	string
refId	int
externalURL	string	The url of endpoint.
type	string	The type of events to listen to, see the area for options.
return	Task

DeleteHook() public method

Deletes the hook with the given id.

Podio API Reference: https://developers.podio.com/doc/hooks/delete-hook-215291

public DeleteHook ( int hookId ) : Task
hookId	int
return	Task

GetHooks() public method

Returns the hooks on the object.

Podio API Reference: https://developers.podio.com/doc/hooks/get-hooks-215285

public GetHooks ( string refType, int refId ) : Task>
refType	string
refId	int
return	Task>

HookService() public method

public HookService ( Podio currentInstance ) : System.Collections.Generic
currentInstance	Podio
return	System.Collections.Generic

ValidateHookVerification() public method

Validates the hook using the code received from the verify call. On successful validation the hook will become active.

Podio API Reference: https://developers.podio.com/doc/hooks/validate-hook-verification-215241

public ValidateHookVerification ( int hookId, string code ) : Task
hookId	int
code	string
return	Task

Verify() public method

Request the hook to be validated. This will cause the hook to send a request to the URL with the parameter "type" set to "hook.verify" and "code" set to the verification code. The endpoint must then call the validate method with the code to complete the verification.

Podio API Reference: https://developers.podio.com/doc/hooks/request-hook-verification-215232

public Verify ( int hookId ) : Task
hookId	int
return	Task