Broadcasts
in package
* Broadcasts resource for looking up and canceling broadcasts.
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 broadcasts resource client.
- cancel() : CancelDetail
- Cancel a broadcast by broadcast ID.
- lookup() : Broadcast
- Lookup a broadcast by broadcast ID.
Methods
__construct()
Creates the broadcasts resource client.
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
-
Shared authenticated HTTP transport used by this resource client.
cancel()
Cancel a broadcast by broadcast ID.
public
cancel(string $broadcastId) : CancelDetail
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $broadcastId : string
-
Unique identifier of the broadcast.
Return values
CancelDetail —The canceled cancel detail.
lookup()
Lookup a broadcast by broadcast ID.
public
lookup(string $broadcastId) : Broadcast
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $broadcastId : string
-
Unique identifier of the broadcast.
Return values
Broadcast —The requested broadcast.