Module twitchpy.dataclasses.creator_goal

Classes

class CreatorGoal (goal_id: str,
channel: Channel,
type: str,
description: str,
current_amount: int,
target_amount: int,
created_at: datetime.datetime)

Expand source code

@dataclass
class CreatorGoal:
    """
    Represents a creator's goal

    Attributes:
        goal_id (str): An ID that identifies this goal
        channel (Channel): The channel where the goal was created
        type (str): The type of goal
            Possible values: follower, subscription, subscription_count, new_subscription, new_subscription_count
        description (str): A description of the goal
        current_amount (int): The goal’s current value
        target_amount (int): The goal’s target value
        created_at (datetime): The UTC date and time (in RFC3339 format) that the broadcaster created the goal
    """

    goal_id: str
    channel: Channel
    type: str
    description: str
    current_amount: int
    target_amount: int
    created_at: datetime

Represents a creator's goal

Attributes

goal_id : str

An ID that identifies this goal

channel : Channel

The channel where the goal was created

type : str

The type of goal Possible values: follower, subscription, subscription_count, new_subscription, new_subscription_count

description : str

A description of the goal

current_amount : int

The goal’s current value

target_amount : int

The goal’s target value

created_at : datetime

The UTC date and time (in RFC3339 format) that the broadcaster created the goal

Class variables

var channel : Channel

The type of the None singleton.

var created_at : datetime.datetime

The type of the None singleton.

var current_amount : int

The type of the None singleton.

var description : str

The type of the None singleton.

var goal_id : str

The type of the None singleton.

var target_amount : int

The type of the None singleton.

var type : str

The type of the None singleton.