Schedules
in package
* Schedules resource for looking up and canceling scheduled chimes.
Request arrays use the API's documented snake_case field names. Successful responses
are returned as immutable values from the corresponding singular resource namespace.
Table of Contents
Methods
- __construct() : mixed
- Creates the schedules resource client.
- cancel() : CancelDetail
- Cancel a scheduled chime by schedule ID.
- lookup() : Schedule
- Lookup a scheduled chime by schedule ID.
Methods
__construct()
Creates the schedules resource client.
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
-
Shared authenticated HTTP transport used by this resource client.
cancel()
Cancel a scheduled chime by schedule ID.
public
cancel(string $scheduleId) : CancelDetail
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $scheduleId : string
-
Unique identifier of the schedule.
Return values
CancelDetail —The canceled cancel detail.
lookup()
Lookup a scheduled chime by schedule ID.
public
lookup(string $scheduleId) : Schedule
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $scheduleId : string
-
Unique identifier of the schedule.
Return values
Schedule —The requested schedule.