Ueberauth.Auth.Info (Überauth v0.11.0)

View Source

Provides a place within the Ueberauth.Auth struct for information about the user.

Summary

Types

t()

Struct for information about the user.

Types

t()

@type t() :: %Ueberauth.Auth.Info{
  birthday: binary() | nil,
  description: binary() | nil,
  email: binary() | nil,
  first_name: binary() | nil,
  image: binary() | nil,
  last_name: binary() | nil,
  location: binary() | nil,
  name: binary() | nil,
  nickname: binary() | nil,
  phone: binary() | nil,
  urls: map()
}

Struct for information about the user.

  • name - The best display name known to the strategy. Usually a concatenation of first and last name, but may also be an arbitrary designator or nickname for some strategies.
  • nickname - The username of an authenticating user (such as your @-name from Twitter or GitHub account name)
  • email - The e-mail of the authenticating user. Should be provided if at all possible (but some sites such as Twitter do not provide this information)
  • location - The general location of the user, usually a city and state.
  • description - A short description of the authenticating user.
  • image - A URL representing a profile image of the authenticating user. Where possible, should be specified to a square, roughly 50x50 pixel image.
  • phone - The telephone number of the authenticating user (no formatting is enforced).
  • birthday - The birthday of an authenticated user.
  • urls - A map containing key value pairs of an identifier for the website and its URL. For instance, an entry could be "Blog" => "http://intridea.com/blog".

Functions

valid?(arg1)