View Source Tentacat.Users.Starring (Tentacat v2.5.0)

Summary

Functions

Star a given repository.

Lists the people that have starred the repository.

List starred repositories for the authenticated user.

List starred repositories for given user.

Check if authenticated user is starred given repository.

Unstar a given repository.

Functions

Link to this function

star(client, owner, repo)

View Source
@spec star(Tentacat.Client.t(), binary(), binary()) :: true | Tentacat.response()

Star a given repository.

Example

Tentacat.Users.Starring.star client, "elixir-lang", "elixir"

More info at: https://developer.github.com/v3/activity/starring/#star-a-repository

Link to this function

stargazers(client, owner, repo)

View Source
@spec stargazers(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()

Lists the people that have starred the repository.

Example

Tentacat.Users.Starring.stargazers client, "edgurgel", "tentacat"

More info at: https://developer.github.com/v3/activity/starring/#list-stargazers

@spec starred(Tentacat.Client.t()) :: Tentacat.response()

List starred repositories for the authenticated user.

Example

Tentacat.Users.Starring.starred client

More info at: https://developer.github.com/v3/activity/starring/#list-repositories-being-starred

Link to this function

starred(client, user_name)

View Source
@spec starred(Tentacat.Client.t(), binary()) :: Tentacat.response()

List starred repositories for given user.

Example

Tentacat.Users.Starring.starred client, "edgurgel"

More info at: https://developer.github.com/v3/activity/starring/#list-repositories-being-starred

Link to this function

starred?(client, owner, repo)

View Source
@spec starred?(Tentacat.Client.t(), binary(), binary()) ::
  boolean() | Tentacat.response()

Check if authenticated user is starred given repository.

Example

Tentacat.Users.Starring.starred? client, "elixir-lang", "elixir"

More info at: https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository

Link to this function

unstar(client, owner, repo)

View Source
@spec unstar(Tentacat.Client.t(), binary(), binary()) :: true | Tentacat.response()

Unstar a given repository.

Example

Tentacat.Users.Starring.unstar client, "elixir-lang", "elixir"

More info at: https://developer.github.com/v3/activity/starring/#unstar-a-repository