Module twitchpy.dataclasses.charity_campaign

Classes

class CharityCampaign (campaign_id: str,
channel: Channel,
charity_name: str,
charity_description: str,
charity_logo: str,
charity_website: str,
current_amount: CharityCampaignAmount,
target_amount: CharityCampaignAmount)

Expand source code

@dataclass
class CharityCampaign:
    """
    Represents a charity campaign

    Attributes:
        campaign_id (str): An ID that identifies the charity campaign
        channel (Channel): The channel that's running the campaign
        charity_name (str): The charity’s name
        charity_description (str): A description of the charity
        charity_logo (str): A URL to an image of the charity’s logo
        charity_website (str): A URL to the charity’s website
        current_amount (CharityCampaignAmount): The current amount of donations that the campaign has received
        target_amount (CharityCampaignAmount): The campaign’s fundraising goal
    """

    campaign_id: str
    channel: Channel
    charity_name: str
    charity_description: str
    charity_logo: str
    charity_website: str
    current_amount: CharityCampaignAmount
    target_amount: CharityCampaignAmount

Represents a charity campaign

Attributes

campaign_id : str

An ID that identifies the charity campaign

channel : Channel

The channel that's running the campaign

charity_name : str

The charity’s name

charity_description : str

A description of the charity

charity_logo : str

A URL to an image of the charity’s logo

charity_website : str

A URL to the charity’s website

current_amount : CharityCampaignAmount

The current amount of donations that the campaign has received

target_amount : CharityCampaignAmount

The campaign’s fundraising goal

Class variables

var campaign_id : str

The type of the None singleton.

var channel : Channel

The type of the None singleton.

var charity_description : str

The type of the None singleton.

var charity_logo : str

The type of the None singleton.

var charity_name : str

The type of the None singleton.

var charity_website : str

The type of the None singleton.

var current_amount : CharityCampaignAmount

The type of the None singleton.

var target_amount : CharityCampaignAmount

The type of the None singleton.