Lingo.Type.Channel (Lingo v0.4.2)

Copy Markdown View Source

A guild channel, thread, DM or group DM.

type is an atom such as :guild_text or :public_thread, or Discord's number for types Lingo doesn't know yet.

Summary

Functions

Returns whether Discord has hidden this channel's sensitive metadata.

Types

channel_type()

@type channel_type() ::
  :guild_text
  | :dm
  | :guild_voice
  | :group_dm
  | :guild_category
  | :guild_announcement
  | :announcement_thread
  | :public_thread
  | :private_thread
  | :guild_stage_voice
  | :guild_directory
  | :guild_forum
  | :guild_media

t()

@type t() :: %Lingo.Type.Channel{
  app_permissions: String.t() | nil,
  application_id: String.t() | nil,
  applied_tags: [String.t()],
  available_tags: [map()],
  bitrate: integer() | nil,
  default_auto_archive_duration: integer() | nil,
  default_forum_layout: integer() | nil,
  default_reaction_emoji: map() | nil,
  default_sort_order: integer() | nil,
  default_thread_rate_limit_per_user: integer() | nil,
  flags: integer(),
  guild_id: String.t() | nil,
  icon: String.t() | nil,
  id: String.t(),
  last_message_id: String.t() | nil,
  last_pin_timestamp: DateTime.t() | nil,
  managed: boolean(),
  member: Lingo.Type.ThreadMember.t() | nil,
  member_count: integer() | nil,
  message: Lingo.Type.Message.t() | nil,
  message_count: integer() | nil,
  name: String.t() | nil,
  nsfw: boolean(),
  owner_id: String.t() | nil,
  parent_id: String.t() | nil,
  permission_overwrites: [Lingo.Type.Overwrite.t()],
  permissions: String.t() | nil,
  position: integer() | nil,
  rate_limit_per_user: integer() | nil,
  recipients: [Lingo.Type.User.t()],
  rtc_region: String.t() | nil,
  thread_metadata: map() | nil,
  topic: String.t() | nil,
  total_message_sent: integer() | nil,
  type: channel_type(),
  user_limit: integer() | nil,
  video_quality_mode: integer() | nil
}

Functions

obfuscated?(channel)

@spec obfuscated?(t()) :: boolean()

Returns whether Discord has hidden this channel's sensitive metadata.