C# Class PayPal.Api.Webhook

A REST API webhook resource object.

See PayPal Developer documentation for more information.

Inheritance: PayPalRelationalObject

Afficher le fichier Open project: paypal/PayPal-NET-SDK Class Usage Examples

Private Properties

Свойство	Type	Description

Méthodes publiques

Méthode	Description
Create ( APIContext apiContext ) : Webhook	Subscribes your webhook listener to events. A successful call returns a [`webhook`](/docs/api/webhooks/#definition-webhook) object, which includes the webhook ID for later use.
Create ( APIContext apiContext, Webhook webhook ) : Webhook	Creates the Webhook for the application associated with the access token.
Delete ( APIContext apiContext ) : void	Deletes a webhook, by ID.
Delete ( APIContext apiContext, string webhookId ) : void	Deletes a webhook, by ID.
Get ( APIContext apiContext, string webhookId ) : Webhook	Shows details for a webhook, by ID.
GetAll ( APIContext apiContext, string anchorType = null ) : WebhookList	Lists all webhooks for an app.
Update ( APIContext apiContext, PatchRequest patchRequest ) : Webhook	Replaces webhook fields with new values. Pass a `json_patch` object with `replace` operation and `path`, which is `/url` for a URL or `/event_types` for events. The `value` is either the URL or a list of events.
Update ( APIContext apiContext, string webhookId, PatchRequest patchRequest ) : Webhook	Updates the Webhook identified by webhook_id for the application associated with access token.

Method Details

Create() public méthode

Subscribes your webhook listener to events. A successful call returns a [`webhook`](/docs/api/webhooks/#definition-webhook) object, which includes the webhook ID for later use.

public Create ( APIContext apiContext ) : Webhook
apiContext	APIContext	APIContext used for the API call.
Résultat	Webhook

Create() public static méthode

Creates the Webhook for the application associated with the access token.

public static Create ( APIContext apiContext, Webhook webhook ) : Webhook
apiContext	APIContext	APIContext used for the API call.
webhook	Webhook	object to be created.
Résultat	Webhook

Delete() public méthode

Deletes a webhook, by ID.

public Delete ( APIContext apiContext ) : void
apiContext	APIContext	APIContext used for the API call.
Résultat	void

Delete() public static méthode

Deletes a webhook, by ID.

public static Delete ( APIContext apiContext, string webhookId ) : void
apiContext	APIContext	APIContext used for the API call.
webhookId	string	The ID of the webhook to delete.
Résultat	void

Get() public static méthode

Shows details for a webhook, by ID.

public static Get ( APIContext apiContext, string webhookId ) : Webhook
apiContext	APIContext	APIContext used for the API call.
webhookId	string	The ID of the webhook for which to show details.
Résultat	Webhook

GetAll() public static méthode

Lists all webhooks for an app.

public static GetAll ( APIContext apiContext, string anchorType = null ) : WebhookList
apiContext	APIContext	APIContext used for the API call.
anchorType	string	Filters the response by an entity type, `anchor_id`. Value is `APPLICATION` or `ACCOUNT`. Default is `APPLICATION`.
Résultat	WebhookList

Update() public méthode

Replaces webhook fields with new values. Pass a `json_patch` object with `replace` operation and `path`, which is `/url` for a URL or `/event_types` for events. The `value` is either the URL or a list of events.

public Update ( APIContext apiContext, PatchRequest patchRequest ) : Webhook
apiContext	APIContext	APIContext used for the API call.
patchRequest	PatchRequest	PatchRequest
Résultat	Webhook

Update() public static méthode

Updates the Webhook identified by webhook_id for the application associated with access token.

public static Update ( APIContext apiContext, string webhookId, PatchRequest patchRequest ) : Webhook
apiContext	APIContext	APIContext used for the API call.
webhookId	string	ID of the webhook to be updated.
patchRequest	PatchRequest	PatchRequest
Résultat	Webhook