Enums¶

The API provides some enumerations for certain types of strings to avoid the API from being stringly typed in case the strings change in the future.

AttachmentTag¶

final class mutiny.enums.AttachmentTag[source]¶

Specifies the attachment tag/bucket used for the mutiny.models.Attachment in the CDN.

ATTACHMENTS = 'attachments'¶: File uploads.

AVATARS = 'avatars'¶: User avatars.

BACKGROUNDS = 'backgrounds'¶: User profile backgrounds.

BANNERS = 'banners'¶: Banners.

ICONS = 'icons'¶: Channel and server icons.

ImageSize¶

final class mutiny.enums.ImageSize[source]¶

Specifies the image size for an embedded image in mutiny.models.EmbeddedImage and mutiny.models.ImageEmbed.

LARGE = 'Large'¶: This is a large image.

PREVIEW = 'Preview'¶: This is a preview image.

BandcampType¶

final class mutiny.enums.BandcampType[source]¶

Specifies the content type for an embedded Bandcamp URL in mutiny.models.EmbeddedBandcamp.

ALBUM = 'Album'¶: This is an embed for a Bandcamp album.

TRACK = 'Track'¶: This is an embed for a Bandcamp track.

TwitchType¶

final class mutiny.enums.TwitchType[source]¶

Specifies the content type for an embedded Twitch URL in mutiny.models.EmbeddedTwitch.

CHANNEL = 'Channel'¶: This is an embed for a Twitch channel.

CLIP = 'Clip'¶: This is an embed for a Twitch clip.

VIDEO = 'Video'¶: This is an embed for a Twitch video.

Presence¶

final class mutiny.enums.Presence[source]¶

Specifies the user’s presence.

BUSY = 'Busy'¶: The user is busy.

IDLE = 'Idle'¶: The user is idle.

INVISIBLE = 'Invisible'¶: The user is invisible.

ONLINE = 'Online'¶: The user is online.

RelationshipStatus¶

final class mutiny.enums.RelationshipStatus[source]¶

Specifies the client user’s relationship with the user.

BLOCKED = 'Blocked'¶: This user is blocked by the client user.

BLOCKED_OTHER = 'BlockedOther'¶: This user has the client user blocked.

FRIEND = 'Friend'¶: This user is the client user’s friend.

INCOMING = 'Incoming'¶: This user has sent a friend request to the client user.

NONE = 'None'¶: This user has no relationship with the client user.

OUTGOING = 'Outgoing'¶: This user has a pending friend request from the client user.

USER = 'User'¶: This is the client user.