Tentacat v1.6.0 Tentacat.Users.Starring View Source
Link to this section Summary
Functions
Star a given 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
Link to this section Functions
star(client, owner, repo)
View Source
star(Tentacat.Client.t(), binary(), binary()) :: true | Tentacat.response()
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
starred(client)
View Source
starred(Tentacat.Client.t()) :: Tentacat.response()
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
starred(client, user_name)
View Source
starred(Tentacat.Client.t(), binary()) :: Tentacat.response()
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
starred?(client, owner, repo)
View Source
starred?(Tentacat.Client.t(), binary(), binary()) ::
boolean() | Tentacat.response()
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
unstar(client, owner, repo)
View Source
unstar(Tentacat.Client.t(), binary(), binary()) :: true | Tentacat.response()
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