hikari.presences

Application and entities that are used to describe guilds on Discord.

Module Contents

class hikari.presences.Activity

Represents a regular activity that can be associated with a presence.

name: str

The activity name.

type: ActivityType | int

The activity type.

url: str | None

The activity URL. Only valid for STREAMING activities.

class hikari.presences.ActivityAssets

Used to represent possible assets for an activity.

property large_image_url: hikari.files.URL | None

Large image asset URL.

Note

This will be None if no large image asset exists or if the asset’s dynamic URL (indicated by a {name}: prefix) is not known.

property small_image_url: hikari.files.URL | None

Small image asset URL.

Note

This will be None if no large image asset exists or if the asset’s dynamic URL (indicated by a {name}: prefix) is not known.

large_image: str | None

The ID of the asset’s large image, if set.

large_text: str | None

The text that’ll appear when hovering over the large image, if set.

small_image: str | None

The ID of the asset’s small image, if set.

small_text: str | None

The text that’ll appear when hovering over the small image, if set.

make_large_image_url(*, ext='png', size=4096)

Generate the large image asset URL for this application.

Note

ext and size are ignored for images hosted outside of Discord or on Discord’s media proxy.

Parameters:

extstr

The extension to use for this URL, defaults to png. Supports png, jpeg, jpg and webp.

sizeint

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 None if no icon exists.

Raises:

ValueError

If the size is not an integer power of 2 between 16 and 4096 (inclusive).

RuntimeError

If ActivityAssets.large_image points towards an unknown asset type.

make_small_image_url(*, ext='png', size=4096)

Generate the small image asset URL for this application.

Parameters:

extstr

The extension to use for this URL, defaults to png. Supports png, jpeg, jpg and webp.

sizeint

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 None if no icon exists.

Raises:

ValueError

If the size is not an integer power of 2 between 16 and 4096 (inclusive).

RuntimeError

If ActivityAssets.small_image points towards an unknown asset type.

class hikari.presences.ActivityFlag

Bases: hikari.internal.enums.Flag

Flags that describe what an activity includes.

This can be more than one using bitwise-combinations.

EMBEDDED

An activity that’s embedded into a voice channel.

INSTANCE

Instance.

JOIN

Join.

JOIN_REQUEST

Join Request.

PARTY_PRIVACY_FRIENDS

Party privacy: friends only.

PARTY_PRIVACY_VOICE_CHANNEL

Party privacy: voice channel only.

PLAY

Play.

SPECTATE

Spectate.

SYNC

Sync.

class hikari.presences.ActivityParty

Used to represent activity groups of users.

current_size: int | None

Current size of this party, if applicable.

id: str | None

The string id of this party instance, if set.

max_size: int | None

Maximum size of this party, if applicable.

class hikari.presences.ActivitySecret

The secrets used for interacting with an activity party.

join: str | None

The secret used for joining a party, if applicable.

match: str | None

The secret used for matching a party, if applicable.

spectate: str | None

The secret used for spectating a party, if applicable.

class hikari.presences.ActivityTimestamps

The datetimes for the start and/or end of an activity session.

end: datetime.datetime | None

When this activity’s session will end, if applicable.

start: datetime.datetime | None

When this activity’s session was started, if applicable.

class hikari.presences.ActivityType

Bases: int, hikari.internal.enums.Enum

The activity type.

COMPETING = 5

Shows up as Competing in.

CUSTOM = 4

A custom status.

To set an emoji with the status, place a unicode emoji or Discord emoji (:smiley:) as the first part of the status activity name.

Warning

Bots DO NOT support setting custom statuses.

LISTENING = 2

Shows up as Listening to.

PLAYING = 0

Shows up as Playing.

STREAMING = 1

Shows up as Streaming and links to a Twitch or YouTube stream/video.

Warning

You MUST provide a valid Twitch or YouTube stream URL to the activity you create in order for this to be valid. If you fail to do this, then the activity WILL NOT update.

WATCHING = 3

Shows up as Watching.

class hikari.presences.ClientStatus

The client statuses for this member.

desktop: Status | str

The status of the target user’s desktop session.

mobile: Status | str

The status of the target user’s mobile session.

web: Status | str

The status of the target user’s web session.

class hikari.presences.MemberPresence

Used to represent a guild member’s presence.

activities: Sequence[RichActivity]

All active user activities.

You can assume the first activity is the one that the GUI Discord client will show.

app: hikari.traits.RESTAware

Client application that models may use for procedures.

client_status: ClientStatus

Platform-specific user-statuses.

guild_id: hikari.snowflakes.Snowflake

The ID of the guild this presence belongs to.

user_id: hikari.snowflakes.Snowflake

The ID of the user this presence belongs to.

visible_status: Status | str

This user’s current status being displayed by the client.

async fetch_member()

Fetch the member this presence is for.

Returns:

hikari.guilds.Member

The requested member.

Raises:

hikari.errors.UnauthorizedError

If you are unauthorized to make the request (invalid/missing token).

hikari.errors.NotFoundError

If the user is not found.

hikari.errors.RateLimitTooLongError

Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

hikari.errors.InternalServerError

If an internal error occurs on Discord while handling the request.

async fetch_user()

Fetch the user this presence is for.

Returns:

hikari.users.User

The requested user.

Raises:

hikari.errors.UnauthorizedError

If you are unauthorized to make the request (invalid/missing token).

hikari.errors.NotFoundError

If the user is not found.

hikari.errors.RateLimitTooLongError

Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

hikari.errors.InternalServerError

If an internal error occurs on Discord while handling the request.

class hikari.presences.RichActivity

Bases: Activity

Represents a rich activity that can be associated with a presence.

application_id: hikari.snowflakes.Snowflake | None

The ID of the application this activity is for, if applicable.

assets: ActivityAssets | None

Images and their hover over text for the activity.

buttons: Sequence[str]

A sequence of up to 2 of the button labels shown in this rich presence.

created_at: datetime.datetime

When this activity was added to the user’s session.

details: str | None

The text that describes what the activity’s target is doing, if set.

emoji: hikari.emojis.Emoji | None

The emoji of this activity, if it is a custom status and set.

flags: ActivityFlag | None

Flags that describe what the activity includes, if present.

is_instance: bool | None

Whether this activity is an instanced game session.

party: ActivityParty | None

Information about the party associated with this activity, if set.

secrets: ActivitySecret | None

Secrets for Rich Presence joining and spectating.

state: str | None

The current status of this activity’s target, if set.

timestamps: ActivityTimestamps | None

The timestamps for when this activity’s current state will start and end, if applicable.

class hikari.presences.Status

Bases: str, hikari.internal.enums.Enum

The status of a member.

DO_NOT_DISTURB = 'dnd'

Do not disturb/red.

IDLE = 'idle'

Idle/yellow.

OFFLINE = 'offline'

Offline or invisible/grey.

ONLINE = 'online'

Online/green.