Hunter.Account (hunter v0.7.0)

Copy Markdown View Source

Account entity

This module defines a Hunter.Account struct.

Fields

  • id - the id of the account
  • username - the username of the account
  • acct - equals username for local users, includes @domain for remote ones
  • display_name - the account's display name
  • locked - boolean for when the account cannot be followed without waiting for approval first
  • created_at - the time the account was created
  • followers_count - the number of followers for the account
  • following_count - the number of accounts the given account is following
  • statuses_count - the number of statuses the account has made
  • note - biography of user
  • url - URL of the user's profile page (can be remote)
  • avatar - URL to the avatar image
  • avatar_static - URL to the avatar static image (gif)
  • header - URL to the header image
  • header_static - URL to the header static image (gif)
  • emojis - list of emojis
  • moved - moved from account
  • fields - list of Hunter.Field, additional profile metadata
  • bot - whether this account is a bot or not
  • group - whether this account represents a group actor
  • discoverable - whether the account has opted into discovery features
  • noindex - whether the local user has opted out of search engine indexing
  • suspended - whether the account has been suspended (returns with limited profile data when true)
  • limited - whether the account has been silenced
  • last_status_at - date (not time) of the account's last status, if any
  • hide_collections - whether the user hides their followers/following collections
  • uri - the ActivityPub actor URI of the account
  • roles - list of Hunter.Role with a visible badge
  • attribution_domains - domains allowed to credit the account in link previews
  • source - profile source data as entered by the user (plain-text note, default privacy, etc.), only returned by verify_credentials and update_credentials

Summary

Types

t()

Types

t()

@type t() :: %Hunter.Account{
  acct: String.t(),
  attribution_domains: [String.t()],
  avatar: String.t(),
  avatar_static: String.t(),
  bot: boolean(),
  created_at: String.t(),
  discoverable: boolean() | nil,
  display_name: String.t(),
  emojis: [Hunter.Emoji.t()],
  fields: [Hunter.Field.t()],
  followers_count: non_neg_integer(),
  following_count: non_neg_integer(),
  group: boolean(),
  header: String.t(),
  header_static: String.t(),
  hide_collections: boolean() | nil,
  id: String.t(),
  last_status_at: String.t() | nil,
  limited: boolean() | nil,
  locked: String.t(),
  moved: t(),
  noindex: boolean() | nil,
  note: String.t(),
  roles: [Hunter.Role.t()],
  source: map() | nil,
  statuses_count: non_neg_integer(),
  suspended: boolean() | nil,
  uri: String.t(),
  url: String.t(),
  username: String.t()
}