PHP Class PayPal\Api\WebhookEventList

List of webhooks events.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addEvent ( WebhookEvent $webhookEvent ) Append Events to the list.
addLink ( PayPal\Api\Links $links ) Append Links to the list.
getCount ( ) : integer The number of items in each range of results. Note that the response might have fewer items than the requested page_size value.
getEvents ( ) : WebhookEvent[] A list of webhooks events.
getLinks ( ) : PayPal\Api\Links[] Gets Links
removeEvent ( WebhookEvent $webhookEvent ) Remove Events from the list.
removeLink ( PayPal\Api\Links $links ) Remove Links from the list.
setCount ( integer $count ) The number of items in each range of results. Note that the response might have fewer items than the requested page_size value.
setEvents ( WebhookEvent[] $events ) A list of webhooks events.
setLinks ( PayPal\Api\Links[] $links ) Sets Links

Method Details

addEvent() public method

Append Events to the list.
public addEvent ( WebhookEvent $webhookEvent )
$webhookEvent WebhookEvent

getCount() public method

The number of items in each range of results. Note that the response might have fewer items than the requested page_size value.
public getCount ( ) : integer
return integer

getEvents() public method

A list of webhooks events.
public getEvents ( ) : WebhookEvent[]
return WebhookEvent[]

removeEvent() public method

Remove Events from the list.
public removeEvent ( WebhookEvent $webhookEvent )
$webhookEvent WebhookEvent

setCount() public method

The number of items in each range of results. Note that the response might have fewer items than the requested page_size value.
public setCount ( integer $count )
$count integer

setEvents() public method

A list of webhooks events.
public setEvents ( WebhookEvent[] $events )
$events WebhookEvent[]