Application and entities that are used to describe guild scheduled events on Discord.

This module

Expand source code
Browse git 
# -*- coding: utf-8 -*-
# cython: language_level=3
# Copyright (c) 2020 Nekokatt
# Copyright (c) 2021-present davfsa
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Application and entities that are used to describe guild scheduled events on Discord."""
from __future__ import annotations

__all__: typing.Sequence[str] = (
    "EventPrivacyLevel",
    "ScheduledEventType",
    "ScheduledEventStatus",
    "ScheduledEvent",
    "ScheduledExternalEvent",
    "ScheduledStageEvent",
    "ScheduledVoiceEvent",
    "ScheduledEventUser",
)

import typing

import attr

from hikari import snowflakes
from hikari import urls
from hikari.internal import attr_extensions
from hikari.internal import enums
from hikari.internal import routes

if typing.TYPE_CHECKING:
    import datetime

    from hikari import files
    from hikari import guilds
    from hikari import traits
    from hikari import users


class EventPrivacyLevel(int, enums.Enum):
    """Enum of the possible scheduled event privacy levels."""

    GUILD_ONLY = 2
    """The scheduled event is only available to guild members."""


class ScheduledEventType(int, enums.Enum):
    """Enum of the scheduled event types."""

    STAGE_INSTANCE = 1
    """A scheduled stage instance."""

    VOICE = 2
    """A scheculed voice chat event."""

    EXTERNAL = 3
    """A scheduled event which takes part outside of Discord."""


class ScheduledEventStatus(int, enums.Enum):
    """Enum of the scheduled event statuses."""

    SCHEDULED = 1
    """Indicates that the scheduled event hasn't occurred yet."""

    ACTIVE = 2
    """Indicates an eventis on-going."""

    COMPLETED = 3
    """Indicates an event has finished."""

    CANCELED = 4
    """Indicates an event has been canceled."""

    CANCELLED = CANCELED
    """Alias of `ScheduledEventStatus.CANCELED`."""


@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class ScheduledEvent(snowflakes.Unique):
    """Base class for scheduled events."""

    # entity_id is ignored right now due to always being null
    # creator_id is ignored as it just dupes creator.id

    app: traits.RESTAware = attr.field(
        repr=False, eq=False, hash=False, metadata={attr_extensions.SKIP_DEEP_COPY: True}
    )
    """The client application that models may use for procedures."""

    id: snowflakes.Snowflake = attr.field(hash=True, repr=True)
    """ID of the scheduled event."""

    guild_id: snowflakes.Snowflake = attr.field(hash=False, repr=True)
    """ID of the guild this scheduled event belongs to."""

    name: str = attr.field(hash=False, repr=True)
    """Name of the scheduled event."""

    description: typing.Optional[str] = attr.field(hash=False, repr=False)
    """Description of the scheduled event."""

    start_time: datetime.datetime = attr.field(hash=False, repr=False)
    """When the event is scheduled to start."""

    end_time: typing.Optional[datetime.datetime] = attr.field(hash=False, repr=False)
    """When the event is scheduled to end, if set."""

    privacy_level: EventPrivacyLevel = attr.field(hash=False, repr=False)
    """Privacy level of the scheduled event.

    This restricts who can view and join the scheduled event.
    """

    status: ScheduledEventStatus = attr.field(hash=False, repr=True)
    """Status of the scheduled event."""

    entity_type: ScheduledEventType = attr.field(hash=False, repr=True)
    """The type of entity this scheduled event is associated with."""

    creator: typing.Optional[users.User] = attr.field(hash=False, repr=False)
    """The user who created the scheduled event.

    This will only be set for event created after 2021-10-25.
    """

    user_count: typing.Optional[int] = attr.field(hash=False, repr=False)
    """The number of users that have subscribed to the event.

    This will be `builtins.None` on gateway events when creating and
    editing a scheduled event.
    """

    image_hash: typing.Optional[str] = attr.field(hash=False, repr=False)
    """Hash of the image used for the scheduled event, if set."""

    @property
    def image_url(self) -> typing.Optional[files.URL]:
        """Cover image for this scheduled event, if set."""
        return self.make_image_url()

    def make_image_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
        """Generate the cover image for this scheduled event, if set.

        Parameters
        ----------
        ext : builtins.str
            The extension to use for this URL, defaults to `png`.
            Supports `png`, `jpeg`, `jpg` and `webp`.
        size : builtins.int
            The size to set for the URL, defaults to `4096`.
            Can be any power of two between 16 and 4096.

        Returns
        -------
        typing.Optional[hikari.files.URL]
            The URL, or `builtins.None` if no cover image is set.

        Raises
        ------
        builtins.ValueError
            If `size` is not a power of two between 16 and 4096 (inclusive).
        """
        if self.image_hash is None:
            return None

        return routes.SCHEDULED_EVENT_COVER.compile_to_file(
            urls.CDN_URL,
            scheduled_event_id=self.id,
            hash=self.image_hash,
            size=size,
            file_format=ext,
        )


@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class ScheduledExternalEvent(ScheduledEvent):
    """A scheduled event that takes place outside of Discord."""

    location: str = attr.field(hash=False, repr=False)
    """The location of the scheduled event.

    !!! note
        There is no strict format for this field, and it will likely be a user
        friendly string.
    """

    end_time: datetime.datetime = attr.field(hash=False, repr=False)
    """When the event is scheduled to end."""


@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class ScheduledStageEvent(ScheduledEvent):
    """A scheduled event that takes place in a stage channel."""

    channel_id: snowflakes.Snowflake = attr.field(hash=False, repr=False)
    """ID of the stage channel this event is scheduled in."""


@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class ScheduledVoiceEvent(ScheduledEvent):
    """A scheduled event that takes place in a voice channel."""

    channel_id: snowflakes.Snowflake = attr.field(hash=False, repr=False)
    """ID of the voice channel this scheduled event is in."""


@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
class ScheduledEventUser:
    """A user who is subscribed to a scheduled event."""

    event_id: snowflakes.Snowflake = attr.field(hash=False, repr=True)
    """ID of the scheduled event they're subscribed to."""

    user: users.User = attr.field(hash=True, repr=True)
    """Object representing the user."""

    member: typing.Optional[guilds.Member] = attr.field(hash=False, repr=False)
    """Their guild member object if they're in the event's guild."""

Classes

enum EventPrivacyLevel

class EventPrivacyLevel (
    value: Any,
): ...

Enum of the possible scheduled event privacy levels.

Expand source code
Browse git 
class EventPrivacyLevel(int, enums.Enum):
    """Enum of the possible scheduled event privacy levels."""

    GUILD_ONLY = 2
    """The scheduled event is only available to guild members."""
Method resolution order
enum EventPrivacyLevel
That's this class!
extern class int

int([x]) -> integer int(x, base=10) -> integer …

enum Enum

Clone of Python's enum.Enum implementation …

Variables and properties
property name : str

Return the name of the enum member as a str.

property value

Return the value of the enum member.

const GUILD_ONLY = 2

The scheduled event is only available to guild members.

dataclass ScheduledEvent

class ScheduledEvent (
    *,
    app: traits.RESTAware,
    id: snowflakes.Snowflake,
    guild_id: snowflakes.Snowflake,
    name: str,
    description: Optional[str],
    start_time: datetime.datetime,
    end_time: Optional[datetime.datetime],
    privacy_level: EventPrivacyLevel,
    status: ScheduledEventStatus,
    entity_type: ScheduledEventType,
    creator: Optional[users.User],
    user_count: Optional[int],
    image_hash: Optional[str],
): ...

Base class for scheduled events.

Method generated by attrs for class ScheduledEvent.

Expand source code
Browse git 
class ScheduledEvent(snowflakes.Unique):
    """Base class for scheduled events."""

    # entity_id is ignored right now due to always being null
    # creator_id is ignored as it just dupes creator.id

    app: traits.RESTAware = attr.field(
        repr=False, eq=False, hash=False, metadata={attr_extensions.SKIP_DEEP_COPY: True}
    )
    """The client application that models may use for procedures."""

    id: snowflakes.Snowflake = attr.field(hash=True, repr=True)
    """ID of the scheduled event."""

    guild_id: snowflakes.Snowflake = attr.field(hash=False, repr=True)
    """ID of the guild this scheduled event belongs to."""

    name: str = attr.field(hash=False, repr=True)
    """Name of the scheduled event."""

    description: typing.Optional[str] = attr.field(hash=False, repr=False)
    """Description of the scheduled event."""

    start_time: datetime.datetime = attr.field(hash=False, repr=False)
    """When the event is scheduled to start."""

    end_time: typing.Optional[datetime.datetime] = attr.field(hash=False, repr=False)
    """When the event is scheduled to end, if set."""

    privacy_level: EventPrivacyLevel = attr.field(hash=False, repr=False)
    """Privacy level of the scheduled event.

    This restricts who can view and join the scheduled event.
    """

    status: ScheduledEventStatus = attr.field(hash=False, repr=True)
    """Status of the scheduled event."""

    entity_type: ScheduledEventType = attr.field(hash=False, repr=True)
    """The type of entity this scheduled event is associated with."""

    creator: typing.Optional[users.User] = attr.field(hash=False, repr=False)
    """The user who created the scheduled event.

    This will only be set for event created after 2021-10-25.
    """

    user_count: typing.Optional[int] = attr.field(hash=False, repr=False)
    """The number of users that have subscribed to the event.

    This will be `builtins.None` on gateway events when creating and
    editing a scheduled event.
    """

    image_hash: typing.Optional[str] = attr.field(hash=False, repr=False)
    """Hash of the image used for the scheduled event, if set."""

    @property
    def image_url(self) -> typing.Optional[files.URL]:
        """Cover image for this scheduled event, if set."""
        return self.make_image_url()

    def make_image_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
        """Generate the cover image for this scheduled event, if set.

        Parameters
        ----------
        ext : builtins.str
            The extension to use for this URL, defaults to `png`.
            Supports `png`, `jpeg`, `jpg` and `webp`.
        size : builtins.int
            The size to set for the URL, defaults to `4096`.
            Can be any power of two between 16 and 4096.

        Returns
        -------
        typing.Optional[hikari.files.URL]
            The URL, or `builtins.None` if no cover image is set.

        Raises
        ------
        builtins.ValueError
            If `size` is not a power of two between 16 and 4096 (inclusive).
        """
        if self.image_hash is None:
            return None

        return routes.SCHEDULED_EVENT_COVER.compile_to_file(
            urls.CDN_URL,
            scheduled_event_id=self.id,
            hash=self.image_hash,
            size=size,
            file_format=ext,
        )
Subclasses
dataclass ScheduledExternalEvent

A scheduled event that takes place outside of Discord …

dataclass ScheduledStageEvent

A scheduled event that takes place in a stage channel …

dataclass ScheduledVoiceEvent

A scheduled event that takes place in a voice channel …

Method resolution order
dataclass ScheduledEvent
That's this class!
abstract class Unique

Mixin for a class that enforces uniqueness by a snowflake ID.

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties
property app : traits.RESTAware

The client application that models may use for procedures.

property created_at : datetime.datetime

When the object was created.

property creator : Optional[users.User]

The user who created the scheduled event.

This will only be set for event created after 2021-10-25.

property description : Optional[str]

Description of the scheduled event.

property end_time : Optional[datetime.datetime]

When the event is scheduled to end, if set.

property entity_type : ScheduledEventType

The type of entity this scheduled event is associated with.

property guild_id : snowflakes.Snowflake

ID of the guild this scheduled event belongs to.

property id : snowflakes.Snowflake

ID of the scheduled event.

property image_hash : Optional[str]

Hash of the image used for the scheduled event, if set.

property image_url : Optional[files.URL]

Cover image for this scheduled event, if set.

property name : str

Name of the scheduled event.

property privacy_level : EventPrivacyLevel

Privacy level of the scheduled event.

This restricts who can view and join the scheduled event.

property start_time : datetime.datetime

When the event is scheduled to start.

property status : ScheduledEventStatus

Status of the scheduled event.

property user_count : Optional[int]

The number of users that have subscribed to the event.

This will be None on gateway events when creating and editing a scheduled event.

Methods
def make_image_url(
    *,
    ext: str = 'png',
    size: int = 4096,
) -> Optional[files.URL]: ...

Generate the cover image for this scheduled event, if set.

Parameters

ext : str
The extension to use for this URL, defaults to png. Supports png, jpeg, jpg and webp.
size : int
The size to set for the URL, defaults to 4096. Can be any power of two between 16 and 4096.

Returns

Optional[URL]
The URL, or None if no cover image is set.

Raises

ValueError
If size is not a power of two between 16 and 4096 (inclusive).
Expand source code
Browse git 
def make_image_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
    """Generate the cover image for this scheduled event, if set.

    Parameters
    ----------
    ext : builtins.str
        The extension to use for this URL, defaults to `png`.
        Supports `png`, `jpeg`, `jpg` and `webp`.
    size : builtins.int
        The size to set for the URL, defaults to `4096`.
        Can be any power of two between 16 and 4096.

    Returns
    -------
    typing.Optional[hikari.files.URL]
        The URL, or `builtins.None` if no cover image is set.

    Raises
    ------
    builtins.ValueError
        If `size` is not a power of two between 16 and 4096 (inclusive).
    """
    if self.image_hash is None:
        return None

    return routes.SCHEDULED_EVENT_COVER.compile_to_file(
        urls.CDN_URL,
        scheduled_event_id=self.id,
        hash=self.image_hash,
        size=size,
        file_format=ext,
    )

enum ScheduledEventStatus

class ScheduledEventStatus (
    value: Any,
): ...

Enum of the scheduled event statuses.

Expand source code
Browse git 
class ScheduledEventStatus(int, enums.Enum):
    """Enum of the scheduled event statuses."""

    SCHEDULED = 1
    """Indicates that the scheduled event hasn't occurred yet."""

    ACTIVE = 2
    """Indicates an eventis on-going."""

    COMPLETED = 3
    """Indicates an event has finished."""

    CANCELED = 4
    """Indicates an event has been canceled."""

    CANCELLED = CANCELED
    """Alias of `ScheduledEventStatus.CANCELED`."""
Method resolution order
enum ScheduledEventStatus
That's this class!
extern class int

int([x]) -> integer int(x, base=10) -> integer …

enum Enum

Clone of Python's enum.Enum implementation …

Variables and properties
property name : str

Return the name of the enum member as a str.

property value

Return the value of the enum member.

const ACTIVE = 2

Indicates an eventis on-going.

const CANCELED = 4

Indicates an event has been canceled.

const CANCELLED = 4

Alias of CANCELED.

const COMPLETED = 3

Indicates an event has finished.

const SCHEDULED = 1

Indicates that the scheduled event hasn't occurred yet.

enum ScheduledEventType

class ScheduledEventType (
    value: Any,
): ...

Enum of the scheduled event types.

Expand source code
Browse git 
class ScheduledEventType(int, enums.Enum):
    """Enum of the scheduled event types."""

    STAGE_INSTANCE = 1
    """A scheduled stage instance."""

    VOICE = 2
    """A scheculed voice chat event."""

    EXTERNAL = 3
    """A scheduled event which takes part outside of Discord."""
Method resolution order
enum ScheduledEventType
That's this class!
extern class int

int([x]) -> integer int(x, base=10) -> integer …

enum Enum

Clone of Python's enum.Enum implementation …

Variables and properties
property name : str

Return the name of the enum member as a str.

property value

Return the value of the enum member.

const EXTERNAL = 3

A scheduled event which takes part outside of Discord.

const STAGE_INSTANCE = 1

A scheduled stage instance.

const VOICE = 2

A scheculed voice chat event.

dataclass ScheduledEventUser

class ScheduledEventUser (
    *,
    event_id: snowflakes.Snowflake,
    user: users.User,
    member: Optional[guilds.Member],
): ...

A user who is subscribed to a scheduled event.

Method generated by attrs for class ScheduledEventUser.

Expand source code
Browse git 
class ScheduledEventUser:
    """A user who is subscribed to a scheduled event."""

    event_id: snowflakes.Snowflake = attr.field(hash=False, repr=True)
    """ID of the scheduled event they're subscribed to."""

    user: users.User = attr.field(hash=True, repr=True)
    """Object representing the user."""

    member: typing.Optional[guilds.Member] = attr.field(hash=False, repr=False)
    """Their guild member object if they're in the event's guild."""
Variables and properties
property event_id : snowflakes.Snowflake

ID of the scheduled event they're subscribed to.

property member : Optional[guilds.Member]

Their guild member object if they're in the event's guild.

property user : users.User

Object representing the user.

dataclass ScheduledExternalEvent

class ScheduledExternalEvent (
    *,
    app: traits.RESTAware,
    id: snowflakes.Snowflake,
    guild_id: snowflakes.Snowflake,
    name: str,
    description: Optional[str],
    start_time: datetime.datetime,
    privacy_level: EventPrivacyLevel,
    status: ScheduledEventStatus,
    entity_type: ScheduledEventType,
    creator: Optional[users.User],
    user_count: Optional[int],
    image_hash: Optional[str],
    location: str,
    end_time: datetime.datetime,
): ...

A scheduled event that takes place outside of Discord.

Method generated by attrs for class ScheduledExternalEvent.

Expand source code
Browse git 
class ScheduledExternalEvent(ScheduledEvent):
    """A scheduled event that takes place outside of Discord."""

    location: str = attr.field(hash=False, repr=False)
    """The location of the scheduled event.

    !!! note
        There is no strict format for this field, and it will likely be a user
        friendly string.
    """

    end_time: datetime.datetime = attr.field(hash=False, repr=False)
    """When the event is scheduled to end."""
Method resolution order
dataclass ScheduledExternalEvent
That's this class!
dataclass ScheduledEvent

Base class for scheduled events …

abstract class Unique

Mixin for a class that enforces uniqueness by a snowflake ID.

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties
property app : traits.RESTAware

The client application that models may use for procedures.

property created_at : datetime.datetime

When the object was created.

property creator : Optional[users.User]

The user who created the scheduled event.

This will only be set for event created after 2021-10-25.

property description : Optional[str]

Description of the scheduled event.

property end_time : datetime.datetime

When the event is scheduled to end.

property entity_type : ScheduledEventType

The type of entity this scheduled event is associated with.

property guild_id : snowflakes.Snowflake

ID of the guild this scheduled event belongs to.

property id : snowflakes.Snowflake

ID of the scheduled event.

property image_hash : Optional[str]

Hash of the image used for the scheduled event, if set.

property image_url : Optional[files.URL]

Cover image for this scheduled event, if set.

property location : str

The location of the scheduled event.

Note

There is no strict format for this field, and it will likely be a user friendly string.

property name : str

Name of the scheduled event.

property privacy_level : EventPrivacyLevel

Privacy level of the scheduled event.

This restricts who can view and join the scheduled event.

property start_time : datetime.datetime

When the event is scheduled to start.

property status : ScheduledEventStatus

Status of the scheduled event.

property user_count : Optional[int]

The number of users that have subscribed to the event.

This will be None on gateway events when creating and editing a scheduled event.

Methods
def make_image_url(
    *,
    ext: str = 'png',
    size: int = 4096,
) -> Optional[files.URL]: ...

Inherited from: ScheduledEvent.make_image_url

Generate the cover image for this scheduled event, if set.

Parameters

ext : str
The extension to use for this URL, defaults to png. Supports png, jpeg, jpg and webp.
size : int
The size to set for the URL, defaults to 4096. Can be any power of two between 16 and 4096.

Returns

Optional[URL]
The URL, or None if no cover image is set.

Raises

ValueError
If size is not a power of two between 16 and 4096 (inclusive).

dataclass ScheduledStageEvent

class ScheduledStageEvent (
    *,
    app: traits.RESTAware,
    id: snowflakes.Snowflake,
    guild_id: snowflakes.Snowflake,
    name: str,
    description: Optional[str],
    start_time: datetime.datetime,
    end_time: Optional[datetime.datetime],
    privacy_level: EventPrivacyLevel,
    status: ScheduledEventStatus,
    entity_type: ScheduledEventType,
    creator: Optional[users.User],
    user_count: Optional[int],
    image_hash: Optional[str],
    channel_id: snowflakes.Snowflake,
): ...

A scheduled event that takes place in a stage channel.

Method generated by attrs for class ScheduledStageEvent.

Expand source code
Browse git 
class ScheduledStageEvent(ScheduledEvent):
    """A scheduled event that takes place in a stage channel."""

    channel_id: snowflakes.Snowflake = attr.field(hash=False, repr=False)
    """ID of the stage channel this event is scheduled in."""
Method resolution order
dataclass ScheduledStageEvent
That's this class!
dataclass ScheduledEvent

Base class for scheduled events …

abstract class Unique

Mixin for a class that enforces uniqueness by a snowflake ID.

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties
property app : traits.RESTAware

The client application that models may use for procedures.

property channel_id : snowflakes.Snowflake

ID of the stage channel this event is scheduled in.

property created_at : datetime.datetime

When the object was created.

property creator : Optional[users.User]

The user who created the scheduled event.

This will only be set for event created after 2021-10-25.

property description : Optional[str]

Description of the scheduled event.

property end_time : Optional[datetime.datetime]

When the event is scheduled to end, if set.

property entity_type : ScheduledEventType

The type of entity this scheduled event is associated with.

property guild_id : snowflakes.Snowflake

ID of the guild this scheduled event belongs to.

property id : snowflakes.Snowflake

ID of the scheduled event.

property image_hash : Optional[str]

Hash of the image used for the scheduled event, if set.

property image_url : Optional[files.URL]

Cover image for this scheduled event, if set.

property name : str

Name of the scheduled event.

property privacy_level : EventPrivacyLevel

Privacy level of the scheduled event.

This restricts who can view and join the scheduled event.

property start_time : datetime.datetime

When the event is scheduled to start.

property status : ScheduledEventStatus

Status of the scheduled event.

property user_count : Optional[int]

The number of users that have subscribed to the event.

This will be None on gateway events when creating and editing a scheduled event.

Methods
def make_image_url(
    *,
    ext: str = 'png',
    size: int = 4096,
) -> Optional[files.URL]: ...

Inherited from: ScheduledEvent.make_image_url

Generate the cover image for this scheduled event, if set.

Parameters

ext : str
The extension to use for this URL, defaults to png. Supports png, jpeg, jpg and webp.
size : int
The size to set for the URL, defaults to 4096. Can be any power of two between 16 and 4096.

Returns

Optional[URL]
The URL, or None if no cover image is set.

Raises

ValueError
If size is not a power of two between 16 and 4096 (inclusive).

dataclass ScheduledVoiceEvent

class ScheduledVoiceEvent (
    *,
    app: traits.RESTAware,
    id: snowflakes.Snowflake,
    guild_id: snowflakes.Snowflake,
    name: str,
    description: Optional[str],
    start_time: datetime.datetime,
    end_time: Optional[datetime.datetime],
    privacy_level: EventPrivacyLevel,
    status: ScheduledEventStatus,
    entity_type: ScheduledEventType,
    creator: Optional[users.User],
    user_count: Optional[int],
    image_hash: Optional[str],
    channel_id: snowflakes.Snowflake,
): ...

A scheduled event that takes place in a voice channel.

Method generated by attrs for class ScheduledVoiceEvent.

Expand source code
Browse git 
class ScheduledVoiceEvent(ScheduledEvent):
    """A scheduled event that takes place in a voice channel."""

    channel_id: snowflakes.Snowflake = attr.field(hash=False, repr=False)
    """ID of the voice channel this scheduled event is in."""
Method resolution order
dataclass ScheduledVoiceEvent
That's this class!
dataclass ScheduledEvent

Base class for scheduled events …

abstract class Unique

Mixin for a class that enforces uniqueness by a snowflake ID.

extern class abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Variables and properties
property app : traits.RESTAware

The client application that models may use for procedures.

property channel_id : snowflakes.Snowflake

ID of the voice channel this scheduled event is in.

property created_at : datetime.datetime

When the object was created.

property creator : Optional[users.User]

The user who created the scheduled event.

This will only be set for event created after 2021-10-25.

property description : Optional[str]

Description of the scheduled event.

property end_time : Optional[datetime.datetime]

When the event is scheduled to end, if set.

property entity_type : ScheduledEventType

The type of entity this scheduled event is associated with.

property guild_id : snowflakes.Snowflake

ID of the guild this scheduled event belongs to.

property id : snowflakes.Snowflake

ID of the scheduled event.

property image_hash : Optional[str]

Hash of the image used for the scheduled event, if set.

property image_url : Optional[files.URL]

Cover image for this scheduled event, if set.

property name : str

Name of the scheduled event.

property privacy_level : EventPrivacyLevel

Privacy level of the scheduled event.

This restricts who can view and join the scheduled event.

property start_time : datetime.datetime

When the event is scheduled to start.

property status : ScheduledEventStatus

Status of the scheduled event.

property user_count : Optional[int]

The number of users that have subscribed to the event.

This will be None on gateway events when creating and editing a scheduled event.

Methods
def make_image_url(
    *,
    ext: str = 'png',
    size: int = 4096,
) -> Optional[files.URL]: ...

Inherited from: ScheduledEvent.make_image_url

Generate the cover image for this scheduled event, if set.

Parameters

ext : str
The extension to use for this URL, defaults to png. Supports png, jpeg, jpg and webp.
size : int
The size to set for the URL, defaults to 4096. Can be any power of two between 16 and 4096.

Returns

Optional[URL]
The URL, or None if no cover image is set.

Raises

ValueError
If size is not a power of two between 16 and 4096 (inclusive).