fyyd_ex v0.1.1 Fyyd.User View Source

Handles requests regarding User.

Link to this section Summary

Functions

Takes the @expected_fields out of a given map and builds a %User{} struct out of it

Gets public available information about a registered account by it’s id

Gets public available information about a registered account by it’s nick

Link to this section Types

Link to this type t() View Source
t() :: %Fyyd.User{
  bio: String.t(),
  fullname: String.t(),
  id: integer(),
  layoutImageURL: String.t(),
  microImageURL: String.t(),
  nick: String.t(),
  thumbImageURL: String.t(),
  url: String.t()
}

Link to this section Functions

Link to this function extract_from_response(data) View Source
extract_from_response(map()) ::
  {:ok,
   %Fyyd.User{
     bio: term(),
     fullname: term(),
     id: term(),
     layoutImageURL: term(),
     microImageURL: term(),
     nick: term(),
     thumbImageURL: term(),
     url: term()
   }}

Takes the @expected_fields out of a given map and builds a %User{} struct out of it.

Link to this function get(id) View Source
get(integer() | String.t()) ::
  {:ok,
   %Fyyd.User{
     bio: term(),
     fullname: term(),
     id: term(),
     layoutImageURL: term(),
     microImageURL: term(),
     nick: term(),
     thumbImageURL: term(),
     url: term()
   }}

Gets public available information about a registered account by it’s id.

Link to this function get_by_nick(nick) View Source
get_by_nick(String.t()) ::
  {:ok,
   %Fyyd.User{
     bio: term(),
     fullname: term(),
     id: term(),
     layoutImageURL: term(),
     microImageURL: term(),
     nick: term(),
     thumbImageURL: term(),
     url: term()
   }}

Gets public available information about a registered account by it’s nick.