class Client

Class Installations.

Methods

__construct(Curl $curl, string $api_url)

Installations constructor.

mixed
listRepositories()

List repositories that are accessible to the authenticated installation.

mixed
listRepositoriesAccessible(int $installation_id)

List repositories that are accessible to the authenticated user for an installation.

void
add(int $installation_id, int $repository_id, string $method = 'put')

Add a single repository to an installation.

void
remove(int $installation_id, int $repository_id)

Remove repository from installation.

mixed
getAppInfo(string $jwt)

No description

mixed
getAccessToken(int $installation_id, string $private_key_path = null)

No description

mixed
findOrganizationInstallation(string $org_name)

Find organization installation.

mixed
findRepositoryInstallation(string $username, string $repo)

Find repository installation.

mixed
findUserInstallation(string $username)

Find user installation.

string
getInstallUrl(int $rid)

某用户或组织的 GitHub App 安装请求地址,即用户在此 URL 安装 GitHub App.

string
getSettingsUrlByUser(int $installation_id)

No description

string
getSettingsUrlByOrg(string $org_name, int $installation_id)

No description

createContentAttachment($content_reference_id, string $title, string $body)

No description

Details

at line 26
__construct(Curl $curl, string $api_url)

Installations constructor.

Parameters

Curl $curl
string $api_url

at line 40
mixed listRepositories()

List repositories that are accessible to the authenticated installation.

Return Value

mixed

Exceptions

Exception

at line 54
mixed listRepositoriesAccessible(int $installation_id)

List repositories that are accessible to the authenticated user for an installation.

Parameters

int $installation_id

Return Value

mixed

Exceptions

Exception

at line 70
void add(int $installation_id, int $repository_id, string $method = 'put')

Add a single repository to an installation.

204

Parameters

int $installation_id
int $repository_id
string $method

Return Value

void

Exceptions

Exception

at line 92
void remove(int $installation_id, int $repository_id)

Remove repository from installation.

204

Parameters

int $installation_id
int $repository_id

Return Value

void

Exceptions

Exception

at line 102
mixed getAppInfo(string $jwt)

Parameters

string $jwt

Return Value

mixed

Exceptions

Exception

at line 120
mixed getAccessToken(int $installation_id, string $private_key_path = null)

Parameters

int $installation_id
string $private_key_path

Return Value

mixed

Exceptions

Exception

at line 192
mixed findOrganizationInstallation(string $org_name)

Find organization installation.

Parameters

string $org_name

Return Value

mixed

Exceptions

Exception

at line 206
mixed findRepositoryInstallation(string $username, string $repo)

Find repository installation.

Parameters

string $username
string $repo

Return Value

mixed

Exceptions

Exception

at line 220
mixed findUserInstallation(string $username)

Find user installation.

Parameters

string $username

Return Value

mixed

Exceptions

Exception

at line 232
string getInstallUrl(int $rid)

某用户或组织的 GitHub App 安装请求地址,即用户在此 URL 安装 GitHub App.

Parameters

int $rid

Return Value

string

at line 241
string getSettingsUrlByUser(int $installation_id)

Parameters

int $installation_id

Return Value

string

at line 249
string getSettingsUrlByOrg(string $org_name, int $installation_id)

Parameters

string $org_name
int $installation_id

Return Value

string

at line 257
createContentAttachment($content_reference_id, string $title, string $body)

Parameters

$content_reference_id
string $title
string $body

See also