Module `twitchpy.dataclasses.subscription`

Classes

class Subscription (channel: Channel, gifter: User, is_gift: bool, tier: str, plan_name: str | None = None, user: User | None = None)

Expand source code

@dataclass
class Subscription:
    """
    Represents a subscription

    Attributes:
        channel (Channel): The channel
        gifter (User): The user that gifted the subscription to the user
        is_gift (bool): A Boolean value that determines whether the subscription is a gift subscription
        tier (str): The type of subscription
            Possible values: 1000, 2000, 3000
        plan_name (str | None): The name of the subscription
        user (User | None): The subscribing user
    """

    channel: Channel
    gifter: User
    is_gift: bool
    tier: str
    plan_name: str | None = None
    user: User | None = None

Represents a subscription

Attributes

channel : Channel: The channel
gifter : User: The user that gifted the subscription to the user
is_gift : bool: A Boolean value that determines whether the subscription is a gift subscription
tier : str: The type of subscription Possible values: 1000, 2000, 3000
plan_name : str | None: The name of the subscription
user : User | None: The subscribing user

Class variables

var channel : Channel: The type of the None singleton.
var gifter : User: The type of the None singleton.
var is_gift : bool: The type of the None singleton.
var plan_name : str | None: The type of the None singleton.
var tier : str: The type of the None singleton.
var user : User | None: The type of the None singleton.