FossabotChannel
interface FossabotChannel implements FossabotDataModel (View source)
Fossabot channel context data model. Contains informationa bout the channel in which the custom API was invoked in.
Methods
String representation of the object. For complex objects, this would normally be a JSON string.
Creates a new Fossabot data model instance from a parsed array of API data.
Channel ID.
Channel log in name. This is the lowercase version of the broadcaster's username.
The uppercased or internationalized version of the boradcaster's username.
URL to the user's profile avatar.
The fossabot channel URL of the broadcaster.
Broadcaster type (i.e. affiliate, partner, etc.).
Broadcaster provider (i.e. twitch, etc.).
Provider ID.
Time the request was created at.
Stream timestamp.
Whether channel is live or not currently.
Details
string
__toString()
String representation of the object.
string
toString()
String representation of the object. For complex objects, this would normally be a JSON string.
string
toJson(int $options = 0)
Convert the object to its JSON representation.
toArray()
No description
static FossabotDataModel
createFromBody(array $body)
Creates a new Fossabot data model instance from a parsed array of API data.
string
id()
Channel ID.
string
login()
Channel log in name. This is the lowercase version of the broadcaster's username.
string
displayName()
The uppercased or internationalized version of the boradcaster's username.
string
avatarUrl()
URL to the user's profile avatar.
string
slug()
The fossabot channel URL of the broadcaster.
string
broadcasterType()
Broadcaster type (i.e. affiliate, partner, etc.).
string
provider()
Broadcaster provider (i.e. twitch, etc.).
string
providerId()
Provider ID.
DateTimeImmutable
createdAt()
Time the request was created at.
DateTimeImmutable
streamTimestamp()
Stream timestamp.
bool
isLive()
Whether channel is live or not currently.