grom - v1.0.2

grom/guild_member

Types

Flag

</> 
pub type Flag {
  DidRejoin
  CompletedOnboarding
  BypassesVerification
  StartedOnboarding
  IsGuest
  StartedHomeActions
  CompletedHomeActions
  QuarantinedBecauseOfUsername
  AcknowledgedDmSettingsUpsell
}

Constructors 

  • DidRejoin
  • CompletedOnboarding
  • BypassesVerification
  • StartedOnboarding
  • IsGuest
  • StartedHomeActions
  • CompletedHomeActions
  • QuarantinedBecauseOfUsername
  • AcknowledgedDmSettingsUpsell

GuildMember

</> 
pub type GuildMember {
  Member(
    user: option.Option(user.User),
    nick: option.Option(String),
    avatar_hash: option.Option(String),
    banner_hash: option.Option(String),
    roles: List(String),
    joined_at: timestamp.Timestamp,
    premium_since: option.Option(timestamp.Timestamp),
    is_deaf: option.Option(Bool),
    is_mute: option.Option(Bool),
    flags: List(Flag),
    is_pending: option.Option(Bool),
    permissions: option.Option(String),
    communication_disabled_until: option.Option(
      timestamp.Timestamp,
    ),
    avatar_decoration_data: option.Option(
      user.AvatarDecorationData,
    ),
  )
}

Constructors

Modify

</> 
pub type Modify {
  Modify(
    nick: modification.Modification(String),
    role_ids: modification.Modification(List(String)),
    is_mute: option.Option(Bool),
    is_deaf: option.Option(Bool),
    voice_channel_id: modification.Modification(String),
    communication_disabled_until: modification.Modification(
      timestamp.Timestamp,
    ),
    flags: modification.Modification(List(Flag)),
  )
}

Constructors

Values

add_role

</> 
pub fn add_role(
  client: grom.Client,
  in guild_id: String,
  to user_id: String,
  id role_id: String,
  because reason: option.Option(String),
) -> Result(Nil, grom.Error)

get

</> 
pub fn get(
  client: grom.Client,
  for guild_id: String,
  id user_id: String,
) -> Result(GuildMember, grom.Error)

kick

</> 
pub fn kick(
  client: grom.Client,
  from guild_id: String,
  id user_id: String,
  because reason: option.Option(String),
) -> Result(Nil, grom.Error)

modify

</> 
pub fn modify(
  client: grom.Client,
  in guild_id: String,
  id user_id: String,
  with modify: Modify,
  because reason: option.Option(String),
) -> Result(GuildMember, grom.Error)

new_modify

</> 
pub fn new_modify() -> Modify

remove

</> 
pub fn remove(
  client: grom.Client,
  from guild_id: String,
  id user_id: String,
  because reason: option.Option(String),
) -> Result(Nil, grom.Error)

remove_role

</> 
pub fn remove_role(
  client: grom.Client,
  in guild_id: String,
  from user_id: String,
  id role_id: String,
  because reason: option.Option(String),
) -> Result(Nil, grom.Error)

set_current_nick

</> 
pub fn set_current_nick(
  client: grom.Client,
  in guild_id: String,
  to nick: modification.Modification(String),
  because reason: option.Option(String),
) -> Result(GuildMember, grom.Error)
✨ Search Document