Skip to content

OcEventAdminNg

FarbodZamani edited this page Mar 28, 2022 · 1 revision

This class contains only a DELETE event REST API call to the /admin-ng/event endpoint. Deleting events by this call results in a permanent and full delete from the system.

Namespace

It is accessible under OpencastApi\Rest namespace.

How to use

  1. In OpencastApi\OpenCast as its property with OpenCast properties naming convention:
use OpencastApi\OpenCast;
$opencastApi = new OpenCast($config);
$ocEventAdminNg = $opencastApi->eventAdminNg;
...
  1. Direct instantiation:
use OpencastApi\Rest\OcRestClient;
use OpencastApi\Rest\OcEventAdminNg;
$ocRestClient = new OcRestClient($config);
$ocEventAdminNg = new OcEventAdminNg($ocRestClient);
...

Functions

Consumable functions are liested below:

delete($eventId)

Delete a single event. More Detail

  • $eventId (string) The id of the event to delete.

  • Returns an array: ['code' => 200, 'reason' => 'OK'] (OK if the event has been deleted.)

Clone this wiki locally