github4s/github4s.interpreters/ActivitiesInterpreter

ActivitiesInterpreter

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

Value members

Concrete methods

override def listPublicOrganizationEvents(org: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[PublicGitHubEvent]]]

List the events of a particular public organization

List the events of a particular public organization

Value parameters:
headers

Optional user headers to include in the request

org

Organization for which we wish to retrieve the events

pagination

Limit and Offset for pagination

Returns:

GHResponse with the list of events for this public organization

Definition Classes
override def listPublicRepositoryEvents(owner: String, repo: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[PublicGitHubEvent]]]

List the events of a particular repository

List the events of a particular repository

Value parameters:
headers

Optional user headers to include in the request

owner

The account owner of the repository. The name is not case sensitive.

pagination

Limit and Offset for pagination

repo

The name of the repository. The name is not case sensitive.

Returns:

GHResponse with the list of events for this public repository

Definition Classes
override def listStargazers(owner: String, repo: String, timeline: Boolean, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Stargazer]]]

List the users having starred a particular repository

List the users having starred a particular repository

Value parameters:
headers

Optional user headers to include in the request

owner

of the repo

pagination

Limit and Offset for pagination

repo

name of the repo

timeline

Whether or not to include the date at which point a user starred the repo

Returns:

GHResponse with the list of users starring this repo

Definition Classes
override def listStarredRepositories(username: String, timeline: Boolean, sort: Option[String], direction: Option[String], pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[StarredRepository]]]

List the repositories starred by a particular user

List the repositories starred by a particular user

Value parameters:
direction

In which direction the results are sorted, can be "asc" or "desc"

headers

Optional user headers to include in the request

pagination

Limit and Offset for pagination

sort

How to sort the result, can be "created" (when the repo was starred) or "updated" (when the repo was last pushed to)

timeline

Whether or not to include the date at which point a user starred the repo

username

User for which we want to retrieve the starred repositories

Returns:

GHResponse with the list of starred repositories for this user

Definition Classes
override def setThreadSub(id: Long, subscribed: Boolean, ignored: Boolean, headers: Map[String, String]): F[GHResponse[Subscription]]

Set a thread subscription

Set a thread subscription

Value parameters:
headers

Optional user headers to include in the request

id

Conversation id for subscribe or unsubscribe

ignored

Determines if all notifications should be blocked from this thread

subscribed

Determines if notifications should be received from this thread

Returns:

GHResponse with the Subscription

Definition Classes