grom - v1.0.2

grom/channel/thread

Types

Flag

</> 
pub type Flag {
  Pinned
}

Constructors 

  • Pinned

Member

</> 
pub type Member {
  Member(
    thread_id: option.Option(String),
    user_id: option.Option(String),
    join_timestamp: timestamp.Timestamp,
    guild_member: option.Option(guild_member.GuildMember),
  )
}

Constructors

Metadata

</> 
pub type Metadata {
  Metadata(
    is_archived: Bool,
    auto_archive_duration: Int,
    archive_timestamp: timestamp.Timestamp,
    is_locked: Bool,
    is_invitable: option.Option(Bool),
    create_timestamp: option.Option(timestamp.Timestamp),
  )
}

Constructors

Modify

</> 
pub type Modify {
  Modify(
    name: option.Option(String),
    is_archived: option.Option(Bool),
    auto_archive_duration: option.Option(duration.Duration),
    is_locked: option.Option(Bool),
    is_invitable: option.Option(Bool),
    rate_limit_per_user: modification.Modification(
      duration.Duration,
    ),
    flags: modification.Modification(List(Flag)),
    applied_tags_ids: modification.Modification(List(String)),
  )
}

Constructors

StartFromMessage

</> 
pub type StartFromMessage {
  StartFromMessage(
    name: String,
    auto_archive_duration: option.Option(duration.Duration),
    rate_limit_per_user: option.Option(duration.Duration),
  )
}

Constructors

StartWithoutMessage

</> 
pub type StartWithoutMessage {
  StartWithoutMessage(
    name: String,
    auto_archive_duration: option.Option(duration.Duration),
    type_: option.Option(Type),
    is_invitable: option.Option(Bool),
    rate_limit_per_user: option.Option(duration.Duration),
  )
}

Constructors

Thread

</> 
pub type Thread {
  Thread(
    id: String,
    type_: Type,
    guild_id: option.Option(String),
    name: String,
    last_message_id: option.Option(String),
    rate_limit_per_user: duration.Duration,
    parent_id: String,
    message_count: Int,
    member_count: Int,
    metadata: option.Option(Metadata),
    current_member: option.Option(Member),
    current_user_permissions: option.Option(
      List(permission.Permission),
    ),
    flags: List(Flag),
    total_message_sent: Int,
    applied_tags_ids: option.Option(List(String)),
  )
}

Constructors

Type

</> 
pub type Type {
  Announcement
  Public
  Private
}

Constructors 

  • Announcement
  • Public
  • Private

Values

add_member

</> 
pub fn add_member(
  client: grom.Client,
  to thread_id: String,
  id user_id: String,
) -> Result(Nil, grom.Error)

get_member

</> 
pub fn get_member(
  client: grom.Client,
  from thread_id: String,
  id user_id: String,
  with_guild_member with_guild_member: Bool,
) -> Result(Member, grom.Error)

get_members

</> 
pub fn get_members(
  client: grom.Client,
  from thread_id: String,
  with_guild_member with_guild_member: Bool,
  older_than_id after: option.Option(String),
  maximum limit: option.Option(Int),
) -> Result(List(Member), grom.Error)

join

</> 
pub fn join(
  client: grom.Client,
  id thread_id: String,
) -> Result(Nil, grom.Error)

leave

</> 
pub fn leave(
  client: grom.Client,
  id thread_id: String,
) -> Result(Nil, grom.Error)

modify

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

new_modify

</> 
pub fn new_modify() -> Modify

new_start_from_message

</> 
pub fn new_start_from_message(name: String) -> StartFromMessage

new_start_without_message

</> 
pub fn new_start_without_message(
  name: String,
) -> StartWithoutMessage

remove_member

</> 
pub fn remove_member(
  client: grom.Client,
  from thread_id: String,
  id user_id: String,
) -> Result(Nil, grom.Error)

start_from_message

</> 
pub fn start_from_message(
  client: grom.Client,
  in channel_id: String,
  from message_id: String,
  with start_from_message: StartFromMessage,
  because reason: option.Option(String),
) -> Result(Thread, grom.Error)

start_without_message

</> 
pub fn start_without_message(
  client: grom.Client,
  in channel_id: String,
  with start_without_message: StartWithoutMessage,
  reason reason: option.Option(String),
) -> Result(Thread, grom.Error)
✨ Search Document