When received over the gateway, the buttons field is an array of strings, which are the button labels. Bots cannot access a user’s activity button URLs. When sending, the buttons field must be an array of this object.

label¶

The text shown on the button (1-32 characters)

Type: str

url¶

The url opened when clicking the button (1-512 characters)

Type: str

Activity¶

Attributes

application_id
assets
buttons
created_at
details
emoji
flags
instance
name
party
secrets
state
timestamps
type
url

class Activity¶

Bases: pincer.utils.api_object.APIObject

Bots are only able to send name, type, and optionally url.

name¶

The activity’s name

Type: str

type¶

Activity type

Type: ActivityType

created_at¶

Unix timestamp (in milliseconds) of when the activity was added to the user’s session

Type: int

url¶

Stream url, is validated when type is 1

Type: APINullable[Optional[str]]

timestamps¶

Unix timestamps for start and/or end of the game

Type: APINullable[ActivityTimestamp]

application_id¶

Application id for the game

Type: APINullable[Snowflake]

details¶

What the player is currently doing

Type: APINullable[Optional[str]]

state¶

The user’s current party status

Type: APINullable[Optional[str]]

emoji¶

The emoji used for a custom status

Type: APINullable[Optional[ActivityEmoji]]

party¶

Information for the current party of the player

Type: APINullable[ActivityParty]

assets¶

Images for the presence and their hover texts

Type: APINullable[ActivityAssets]

secrets¶

Secrets for Rich Presence joining and spectating

Type: APINullable[ActivitySecrets]

instance¶

“nether or not the activity is an instanced game session

Type: APINullable[bool]

flags¶

Activity flags ORd together, describes what the payload includes

Type: APINullable[ActivityFlags]

buttons¶

The url button on an activity.

Type: APINullable[List[ActivityButton]]

ClientStatus¶

Attributes

desktop
mobile
web

class ClientStatus¶

Bases: pincer.utils.api_object.APIObject

Active sessions are indicated with an “online”, “idle”, or “dnd” string per platform. If a user is offline or invisible, the corresponding field is not present.

desktop¶

The user’s status set for an active desktop (Windows, Linux, Mac) application session

Type: APINullable[str]

mobile¶

The user’s status set for an active mobile (iOS, Android) application session

Type: APINullable[str]

web¶

The user’s status set for an active web (browser, bot account) application session

Type: APINullable[str]

PresenceUpdateEvent¶

Attributes

activities
client_status
guild_id
status
user

class PresenceUpdateEvent¶

Bases: pincer.utils.api_object.APIObject

This event is sent when a user’s presence or info, such as name or avatar, is updated.

user¶

The user presence is being updated for

Type: User

guild_id¶

Id of the guild

Type: Snowflake

status¶

Either “idle”, “dnd”, “online”, or “offline”

Type: str

activities¶

User’s current activities

Type: List[Activity]

client_status¶

User’s platform-dependent status

Type: ClientStatus

Thread¶

ThreadListSyncEvent¶

Attributes

channel_ids
guild_id
members
threads

class ThreadListSyncEvent¶

Bases: pincer.utils.api_object.APIObject

Sent when the current user gains access to a channel.

guild_id¶

The id of the guild

Type: Snowflake

threads¶

All active threads in the given channels that the current user can access

Type: List[Channel]

members¶

All thread member objects from the synced threads for the current user, indicating which threads the current user has been added to

Type: List[ThreadMember]

channel_ids¶

The parent channel ids whose threads are being synced. If omitted, then threads were synced for the entire guild. This array may contain channel_ids that have no active threads as well, so you know to clear that data.

Type: APINullable[List[Snowflake]]

ThreadMembersUpdateEvent¶

Attributes

added_members
guild_id
id
member_count
removed_member_ids

class ThreadMembersUpdateEvent¶

Bases: pincer.utils.api_object.APIObject

Sent when anyone is added to or removed from a thread. If the current user does not have the GUILD_MEMBERS Gateway Intent, then this event will only be sent if the current user was added to or removed from the thread.

id¶

The id of the thread

Type: Snowflake

guild_id¶

The id of the guild

Type: Snowflake

member_count¶

The approximate number of members in the thread, capped at 50

Type: int

added_members¶

The users who were added to the thread

Type: APINullable[List[ThreadMember]]

removed_member_ids¶

The id of the users who were removed from the thread

Type: APINullable[List[Snowflake]]

Typing Start¶

TypingStartEvent¶

Attributes

channel_id
guild_id
member
timestamp
user_id

class TypingStartEvent¶

Bases: pincer.utils.api_object.APIObject

Sent when a user starts typing in a channel.

channel_id¶

Id of the channel

Type: Snowflake

user_id¶

Id of the user

Type: Snowflake

timestamp¶

Unix time (in seconds) of when the user started typing

Type: int

guild_id¶

Id of the guild

Type: APINullable[Snowflake]

member¶

The member who started typing if this happened in a guild

Type: APINullable[GuildMember]

Voice¶

VoiceServerUpdateEvent¶

Attributes

endpoint
guild_id
token

class VoiceServerUpdateEvent¶

Bases: pincer.utils.api_object.APIObject

Sent when a guild’s voice server is updated. This is sent when initially connecting to voice, and when the current voice instance fails over to a new server.

token¶

Voice connection token