GithubClient class

Constructors

GithubClient({String github_api_version = "2022-11-28", Client? httpClient})

Properties

api_github_uri → Uri

no setter

github_api_version ↔ String

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

http_client ↔ Client

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addBlockedUser({required String username, GithubClientAuth? githubClientAuth}) → Future<UserBlocked>

DOCS: https://docs.github.com/en/rest/users/blocking?apiVersion=2022-11-28#block-a-user

addSocialAccounts({required List<String> accountUrls, GithubClientAuth? githubClientAuth}) → Future<SocialAccounts>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#list-users

followUser({required String username, GithubClientAuth? githubClientAuth}) → Future<UserFollowed>

DOCS: https://docs.github.com/en/rest/users/followers?apiVersion=2022-11-28#follow-a-user

getBlockedUser({required String username, GithubClientAuth? githubClientAuth}) → Future<UserBlocked>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#list-users

getBlockedUsers({int perPage = 30, int page = 1, GithubClientAuth? githubClientAuth}) → Future<Users>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#list-users

getFollowedUser({required String username, GithubClientAuth? githubClientAuth}) → Future<UserFollowed>

DOCS: https://docs.github.com/en/rest/users/followers?apiVersion=2022-11-28#list-the-people-the-authenticated-user-follows

getFollowersUser({required String username, int page = 1, int perPage = 30, GithubClientAuth? githubClientAuth}) → Future<Users>

DOCS: https://docs.github.com/en/rest/users/followers?apiVersion=2022-11-28#list-followers-of-the-authenticated-user

getFollowerUsers({int page = 1, int perPage = 30, GithubClientAuth? githubClientAuth}) → Future<Users>

DOCS: https://docs.github.com/en/rest/users/followers?apiVersion=2022-11-28#list-followers-of-the-authenticated-user

getFollowingsUser({required String username, int page = 1, int perPage = 30, GithubClientAuth? githubClientAuth}) → Future<Users>

DOCS: https://docs.github.com/en/rest/users/followers?apiVersion=2022-11-28#list-followers-of-the-authenticated-user

getFollowingUsers({int page = 1, int perPage = 30, GithubClientAuth? githubClientAuth}) → Future<Users>

DOCS: https://docs.github.com/en/rest/users/followers?apiVersion=2022-11-28#list-followers-of-the-authenticated-user

getFollowUserFollowUser({required String username, required String targetUsername, GithubClientAuth? githubClientAuth}) → Future<UserFollowed>

DOCS: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user

getMe({GithubClientAuth? githubClientAuth}) → Future<User>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-the-authenticated-user

getSocialAccounts({int? since, int perPage = 30, GithubClientAuth? githubClientAuth}) → Future<SocialAccounts>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#list-users

getSocialAccountsUser({required String username, int? since, int perPage = 30, GithubClientAuth? githubClientAuth}) → Future<SocialAccounts>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#list-users

getUser({required String username, GithubClientAuth? githubClientAuth}) → Future<User>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-a-user

getUserHoverCard({required String username, String? subjectId, String? subjectType, GithubClientAuth? githubClientAuth}) → Future<User>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-contextual-information-for-a-user

getUsers({int? since, int perPage = 30, GithubClientAuth? githubClientAuth}) → Future<Users>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#list-users

invoke({required String uriPath, Map<String, dynamic>? uriQueryParameters, Map? parameters, Map? headersParameters, GithubClientAuth? githubClientAuth, String? githubApiVersion, List<int>? statusCodes, String? keyResultList, String method_request = "get", String specialTypeName = "ok"}) → FutureOr<Map>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeBlockedUser({required String username, GithubClientAuth? githubClientAuth}) → Future<UserBlocked>

DOCS: https://docs.github.com/en/rest/users/blocking?apiVersion=2022-11-28#unblock-a-user

removeSocialAccounts({required List<String> accountUrls, GithubClientAuth? githubClientAuth}) → Future<Ok>

DOCS: https://docs.github.com/en/rest/users/followers?apiVersion=2022-11-28#unfollow-a-user

toString() → String

A string representation of this object.

inherited

unFollowUser({required String username, GithubClientAuth? githubClientAuth}) → Future<UserFollowed>

DOCS: https://docs.github.com/en/rest/users/followers?apiVersion=2022-11-28#unfollow-a-user

updateUser({String? newName, String? newEmail, String? newBlog, String? newTwitterUsername, String? newCompany, String? newLocation, bool? newHireable, String? newBio, GithubClientAuth? githubClientAuth}) → Future<User>

DOCS: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#update-the-authenticated-user

Operators

operator ==(Object other) → bool

The equality operator.

inherited