Enumerations

These classes are used to describe various enums from Revolt API so you don’t have to remember these enums and can easily reference them in your code.

WebsocketEvent

class luster.WebsocketEvent

An enumeration detailing the names of websocket events.

AUTHENTICATED = 'Authenticated'

The authenticated event is emitted right after authenticating the websocket session.

CHANNEL_CREATE = 'ChannelCreate'

This event is emitted when a channel is created.

CHANNEL_DELETE = 'ChannelDelete'

This event is emitted when a channel is deleted.

CHANNEL_GROUP_JOIN = 'ChannelGroupJoin'

This event is emitted when a user joins a group.

CHANNEL_GROUP_LEAVE = 'ChannelGroupLeave'

This event is emitted when a user joins a group.

CHANNEL_UPDATE = 'ChannelUpdate'

This event is emitted when a channel is updated.

GROUP_JOIN = 'ChannelGroupJoin'

An alias for CHANNEL_GROUP_JOIN

GROUP_LEAVE = 'ChannelGroupLeave'

An alias for CHANNEL_GROUP_LEAVE

PONG = 'Pong'

The pong event is emitted when client pings the websocket.

READY = 'Ready'

The ready event is emitted when client is ready.

ROLE_CREATE = 'ServerRoleCreate'

An alias for SERVER_ROLE_CREATE

ROLE_DELETE = 'ServerRoleDelete'

An alias for SERVER_ROLE_DELETE

ROLE_UPDATE = 'ServerRoleUpdate'

An alias for SERVER_ROLE_UPDATE

SERVER_CREATE = 'ServerCreate'

This event is emitted when a server is created/joined by our user.

SERVER_DELETE = 'ServerDelete'

This event is emitted when a server is deleted by our user.

SERVER_ROLE_CREATE = 'ServerRoleCreate'

This event is emitted when a server role is created.

SERVER_ROLE_DELETE = 'ServerRoleDelete'

This event is emitted when a server role is deleted.

SERVER_ROLE_UPDATE = 'ServerRoleUpdate'

This event is emitted when a server role is updated.

SERVER_UPDATE = 'ServerUpdate'

This event is emitted when a server is updated.

USER_RELATIONSHIP = 'UserRelationship'

This event is emitted when your relationship with a user updates.

USER_RELATIONSHIP_UPDATE = 'UserRelationship'

An alias for USER_RELATIONSHIP.

USER_UPDATE = 'UserUpdate'

This event is emitted when a user is updated.

FileTag

class luster.FileTag

An enumeration detailing values for tag of File.

ATTACHMENTS = 'attachments'

The file is an attachment.

AVATARS = 'avatars'

The file is an avatar.

BACKGROUNDS = 'backgrounds'

The file is a profile background.

BANNERS = 'banners'

The file is a banner.

EMOJIS = 'emojis'

The file is an emoji.

ICONS = 'icons'

The file is an icon.

FileType

class luster.FileType

An enumeration detailing the values for type of a File.

FILE = 'File'

The default file.

RelationshipStatus

class luster.RelationshipStatus

An enumeration detailing values for status of a Relationship.

BLOCKED = 'Blocked'

Blocked user.

BLOCKED_OTHER = 'BlockedOther'

Blocked other user.

FRIEND = 'Friend'

Friend relationship.

INCOMING = 'Incoming'

Incoming friend request.

NONE = 'None'

No relationship.

OUTGOING = 'Outgoing'

Outgoing friend request.

USER = 'User'

User relationship.

PresenceType

class luster.PresenceType

An enumeration detailing values for Status.presence

BUSY = 'Busy'

The user is on DND (Do Not Disturb).

IDLE = 'Idle'

The user is on Idle.

INVISIBLE = 'Invisible'

The user is offline.

ONLINE = 'Online'

The user is online.

ChannelType

class luster.ChannelType

An enumeration detailing values for a channel type.

DIRECT_MESSAGE = 'DirectMessage'

A DM channel between two users.

GROUP = 'Group'

A private group between several users.

SAVED_MESSAGES = 'SavedMessages'

Saved notes channel.

TEXT_CHANNEL = 'TextChannel'

A text channel belonging to a server.

VOICE_CHANNEL = 'VoiceChannel'

A voice channel belonging to a server.