Users

github4s.algebras.Users
trait Users[F[_]]

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class UsersInterpreter[F]

Members list

Value members

Abstract methods

def get(username: String, headers: Map[String, String]): F[GHResponse[User]]

Get information for a particular user

Get information for a particular user

Value parameters

headers

optional user headers to include in the request

username

of the user to retrieve

Attributes

Returns

GHResponse[User] User details

def getAuth(headers: Map[String, String]): F[GHResponse[User]]

Get information of the authenticated user

Get information of the authenticated user

Value parameters

headers

optional user headers to include in the request

Attributes

Returns

GHResponse[User] User details

def getEmails(pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Email]]]

Get information for an authenticated user's associated email addresses

Get information for an authenticated user's associated email addresses

Value parameters

headers

optional user headers to include in the request

pagination

Limit and Offset for pagination

Attributes

Returns

GHResponse[Email] Email details

def getFollowing(username: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[User]]]

Get information for a particular user's list of users they follow

Get information for a particular user's list of users they follow

Value parameters

headers

optional user headers to include in the request

pagination

Limit and Offset for pagination

username

of the user to retrieve

Attributes

Returns

GHResponse[User] User details

def getUsers(since: Int, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[User]]]

Get users

Get users

Value parameters

headers

optional user headers to include in the request

pagination

Limit and Offset for pagination

since

The integer ID of the last User that you've seen.

Attributes

Returns

GHResponse[List[User]] List of user's details