SeanOMik
/
nimcord
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation to guild.nim

This commit is contained in:
Intexisty 2020-08-13 13:35:26 -05:00
parent 8307daff81
commit befff9d294
No known key found for this signature in database
GPG Key ID: 0F63AD8E987C9A17
1 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
src/nimcord/guild.nim
View File

@ -67,42 +67,42 @@ type
Guild* = ref object of DiscordObject Guild* = ref object of DiscordObject
## Discord Guild object ## Discord Guild object
name*: string name*: string ## The name of the current guild
icon*: string icon*: string ## The hash of the current guild's icon
splash*: string splash*: string ## The hash of the current guild's splash
discoverySplash*: string discoverySplash*: string
owner*: bool owner*: bool ## Whether or not the current user is the owner of the current guild
ownerID: Snowflake ownerID: Snowflake ## The snowflake id of the current guild's owner
permissions*: Permissions permissions*: Permissions
region*: string region*: string ## The region of the current guild
afkChannelID*: Snowflake afkChannelID*: Snowflake ## The afk voice channel of the current guild
afkTimeout*: int afkTimeout*: int ## The afk timeout of the current guild
verificationLevel*: VerificationLevel verificationLevel*: VerificationLevel ## The verification level of the current guild
defaultMessageNotifications*: MessageNotificationsLevel defaultMessageNotifications*: MessageNotificationsLevel ## The message notification level of the current guild
explicitContentFilter*: ExplicitContentFilterLevel explicitContentFilter*: ExplicitContentFilterLevel ## The explicit content filter level of the current guild
roles*: seq[Role] roles*: seq[Role] ## The role list of the current guild
emojis*: seq[Emoji] emojis*: seq[Emoji] ## The emoji list of the current guild
features*: seq[string] features*: seq[string]
mfaLevel*: MFALevel mfaLevel*: MFALevel ## Whether or not ADMIN permission requires multi-factor authentication
applicationID*: Snowflake applicationID*: Snowflake
widgetEnabled*: bool widgetEnabled*: bool
widgetChannelID*: Snowflake widgetChannelID*: Snowflake
systemChannelID*: Snowflake systemChannelID*: Snowflake ## The system channel id of the current guild
systemChannelFlags*: int systemChannelFlags*: int
rulesChannelID*: Snowflake rulesChannelID*: Snowflake
joinedAt*: string joinedAt*: string
large*: bool large*: bool
unavailable*: bool unavailable*: bool ## Whether or not the current guild is unavailable
memberCount*: int memberCount*: int ## The approximate membercount of the current guild (sent by discord)
voiceStates*: seq[VoiceState] voiceStates*: seq[VoiceState]
members*: seq[GuildMember] members*: seq[GuildMember] ## The member list of the current guild
channels*: seq[Channel] channels*: seq[Channel] ## The channel list of the current guild
#presences*: seq[Presence] #presences*: seq[Presence]
maxPresences*: int maxPresences*: int ## The maximum amount of presences in the current guild
maxMembers*: int maxMembers*: int ## The maximum amount of members in the current guild?
vanityUrlCode*: string vanityUrlCode*: string ## The vanity invite for the current guild (ex: https://discord.gg/discord-api)
description*: string description*: string
banner*: string banner*: string ## The hash code of the current guild
premiumTier*: PremiumTier premiumTier*: PremiumTier
premiumSubscriptionCount*: int premiumSubscriptionCount*: int
preferredLocale*: string preferredLocale*: string
@ -125,8 +125,8 @@ type
GuildBan* = ref object GuildBan* = ref object
## A guild ban. ## A guild ban.
reason*: string reason*: string ## The reason the user was banned
user*: User user*: User ## The user object that was banned
VoiceRegion* = ref object VoiceRegion* = ref object
## Voice region. ## Voice region.