JGithubPackageUsersEmails

Extends \JGithubPackage

GitHub API References class for the Joomla Platform.

deprecated

Management of email addresses via the API requires that you are authenticated through basic auth or OAuth with the user scope.

documentation

https://developer.github.com/v3/users/emails

since

3.1.4

deprecated

4.0 Use the joomla/github package via Composer instead

package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null) 
inherited
since

1.7.3

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\JGithubHttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \JGithubPackage
inherited
since

3.3

throws

\RuntimeException

Arguments

$name

stringName of property to retrieve

Response

\JGithubPackageGitHub API package object.

add

Add email address(es).

add(string|array $email) : object
since

3.3

Arguments

$email

string|arrayThe email address(es).

Response

object

delete

Delete email address(es).

delete(string|array $email) : object
since

3.3

Arguments

$email

string|arrayThe email address(es).

Response

object

fetchUrl

Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.

fetchUrl(string $path, integer $page, integer $limit) : string
inherited
since

1.7.3

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

getList

List email addresses for a user.

getList() : object

Future response: In the final version of the API, this method will return an array of hashes with extended information for each email address indicating if the address has been verified and if it’s the user’s primary email address for GitHub.

Until API v3 is finalized, use the application/vnd.github.v3 media type to get this response format.

since

3.3

Response

object

processResponse

Process the response and decode it.

processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
inherited
throws

\DomainException

since

3.3.0

Arguments

$response

\JHttpResponseThe response.

$expectedCode

integerThe expected "good" code.

$decode

booleanIf the should be response be JSON decoded.

Response

mixed

Properties

name

inherited
since

3.3

Type(s)

string

packages

inherited
since

3.3

Type(s)

array

options

Options for the GitHub object.

inherited
since

1.7.3

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.7.3

Type(s)

\JGithubHttp