FossabotChannel
final class FossabotChannel extends FossabotDataModel implements FossabotChannel (View source)
Fossabot channel context data model. Contains information about the channel in which the custom API was invoked in.
Traits
Trait to consolidate the methods needs to implement the \Brandon14\FossabotCommander\Contracts\Stringable interface.
Trait to consolidate functionality of converting a class to JSON representation.
Properties
| protected | $data | Data model. |
from FossabotDataModel |
Methods
Magic method https://www.php.net/manual/en/language.oop5.magic.php#object. toString allows a class to decide how it will react when it is treated like a 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
toJson($options = 0)
{@inheritDoc}
__toString()
Magic method https://www.php.net/manual/en/language.oop5.magic.php#object. toString allows a class to decide how it will react when it is treated like a string.
string
toString()
{@inheritDoc}
bool
offsetExists(string $offset)
Whether an offset exists.
offsetGet(string $offset)
Offset to retrieve.
void
offsetSet(string $offset, mixed $value)
Offset to set.
void
offsetUnset(string $offset)
Offset to unset.
array
__serialize()
Serializes data.
void
__unserialize(array $data)
Unserializes data.
__get(string $name)
Gets property.
void
__set(string $name, mixed $value)
Sets property.
bool
__isset(string $name)
Checks for existence of property.
void
__unset(string $name)
Unsets property.
array
jsonSerialize()
Specify data which should be serialized to JSON.
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.