github4s/github4s.interpreters/UsersInterpreter

UsersInterpreter

class UsersInterpreter[F[_]](implicit client: HttpClient[F]) extends Users[F]
trait Users[F]
class Object
trait Matchable
class Any

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

Value parameters:
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

Value parameters:
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

Value parameters:
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

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.

Returns:

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

Definition Classes