Class LiveThread

praw/models/reddit/live.py:262–473

An individual :class:`.LiveThread` object. .. include:: ../../typical_attributes.rst ==================== ========================================================= Attribute Description ==================== ========================================================= ``

class LiveThread(CreatedMixin, RedditBase):
    """An individual :class:`.LiveThread` object.

    .. include:: ../../typical_attributes.rst

    ==================== =========================================================
    Attribute            Description
    ==================== =========================================================
    ``created_utc``      The creation time of the live thread, in `Unix Time`_.
    ``description``      Description of the live thread, as Markdown.
    ``description_html`` Description of the live thread, as HTML.
    ``id``               The ID of the live thread.
    ``nsfw``             A ``bool`` representing whether or not the live thread is
                         marked as NSFW.
    ==================== =========================================================

    .. _unix time: https://en.wikipedia.org/wiki/Unix_time

    """

    STR_FIELD = "id"

    @cachedproperty
    def contrib(self) -> LiveThreadContribution:
        """Provide an instance of :class:`.LiveThreadContribution`.

        Usage:

        .. code-block:: python

            thread = reddit.live("ukaeu1ik4sw5")
            thread.contrib.add("### update")

        """
        return LiveThreadContribution(self)

    @cachedproperty
    def contributor(self) -> LiveContributorRelationship:
        """Provide an instance of :class:`.LiveContributorRelationship`.

        You can call the instance to get a list of contributors which is represented as
        :class:`.RedditorList` instance consists of :class:`.Redditor` instances. Those
        :class:`.Redditor` instances have ``permissions`` attributes as contributors:

        .. code-block:: python

            thread = reddit.live("ukaeu1ik4sw5")
            for contributor in thread.contributor():
                # prints `Redditor(name="Acidtwist") ["all"]`
                print(contributor, contributor.permissions)

        """
        return LiveContributorRelationship(self)

    @cachedproperty
    def stream(self) -> LiveThreadStream:
        """Provide an instance of :class:`.LiveThreadStream`.