Skip to content

feat: update docs and support state for custom statuses #1527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 15, 2023
Merged

feat: update docs and support state for custom statuses #1527

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0dc9c02
feat: update docs and support state for custom statuses
AstreaTSS Aug 10, 2023
a8ffc23
docs: little adjustments to docs
AstreaTSS Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions interactions/models/discord/activity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class Activity(DictSerializationMixin):
details: Optional[str] = attrs.field(repr=False, default=None)
"""What the player is currently doing"""
state: Optional[str] = attrs.field(repr=False, default=None)
"""The user's current party status"""
"""The user's current party status, or text used for a custom status if type is set as CUSTOM"""
emoji: Optional[PartialEmoji] = attrs.field(repr=False, default=None, converter=optional(PartialEmoji.from_dict))
"""The emoji used for a custom status"""
party: Optional[ActivityParty] = attrs.field(repr=False, default=None, converter=optional(ActivityParty.from_dict))
Expand All @@ -99,20 +99,23 @@ class Activity(DictSerializationMixin):
"""The custom buttons shown in the Rich Presence (max 2)"""

@classmethod
def create(cls, name: str, type: ActivityType = ActivityType.GAME, url: Optional[str] = None) -> "Activity":
def create(
cls, name: str, type: ActivityType = ActivityType.GAME, url: Optional[str] = None, state: Optional[str] = None
) -> "Activity":
"""
Creates an activity object for the bot.

Args:
name: The new activity's name
type: Type of activity to create
url: Stream link for the activity
state: Current party status, or text used for a custom status if type is set as CUSTOM

Returns:
The new activity object

"""
return cls(name=name, type=type, url=url)
return cls(name=name, type=type, url=url, state=state)

def to_dict(self) -> dict:
return dict_filter_none({"name": self.name, "type": self.type, "url": self.url})
return dict_filter_none({"name": self.name, "type": self.type, "state": self.state, "url": self.url})