Module twitchpy.dataclasses.hypetrain_event

Classes

class HypeTrainEvent (event_id: str,
event_type: str,
event_timestamp: datetime.datetime,
version: str,
event_data: HypeTrainEventData)

Expand source code

@dataclass
class HypeTrainEvent:
    """
    Represents a Hype Train event

    Attributes:
        event_id (str): The distinct ID of the event
        event_type (str): Displays hypetrain.{event_name}, currently only hypetrain.progression
        event_timestamp (datetime): RFC3339 formatted timestamp of event
        version (str): Returns the version of the endpoint
        event_data (dict): The event data
    """

    event_id: str
    event_type: str
    event_timestamp: datetime
    version: str
    event_data: HypeTrainEventData

Represents a Hype Train event

Attributes

event_id : str

The distinct ID of the event

event_type : str

Displays hypetrain.{event_name}, currently only hypetrain.progression

event_timestamp : datetime

RFC3339 formatted timestamp of event

version : str

Returns the version of the endpoint

event_data : dict

The event data

Class variables

var event_data : HypeTrainEventData

The type of the None singleton.

var event_id : str

The type of the None singleton.

var event_timestamp : datetime.datetime

The type of the None singleton.

var event_type : str

The type of the None singleton.

var version : str

The type of the None singleton.