UsersInterpreter

github4s.interpreters.UsersInterpreter
class UsersInterpreter[F[_]](implicit client: HttpClient[F]) extends Users[F]

Attributes

Graph
Supertypes
trait Users[F]
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

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

Get information for a particular user

Get information for a particular user

Attributes

headers

optional user headers to include in the request

username

of the user to retrieve

Returns:

GHResponse[User] User details

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

Get information of the authenticated user

Get information of the authenticated user

Attributes

headers

optional user headers to include in the request

Returns:

GHResponse[User] User details

Definition Classes
override 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

Attributes

headers

optional user headers to include in the request

pagination

Limit and Offset for pagination

username

of the user to retrieve

Returns:

GHResponse[User] User details

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

Get users

Get users

Attributes

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.

Returns:

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

Definition Classes