Foundry.ForgeProject¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`dup_avatar_url` ()
	`dup_description` ()
	`dup_issues_url` ()
	`dup_merge_requests_url` ()
	`dup_online_url` ()
	`dup_title` ()
	`list_issues` (query)
	`list_merge_requests` (query)
	`load_avatar` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_dup_avatar_url` ()
	`do_dup_description` ()
	`do_dup_issues_url` ()
	`do_dup_merge_requests_url` ()
	`do_dup_online_url` ()
	`do_dup_title` ()
	`do_list_issues` (query)
	`do_list_merge_requests` (query)
	`do_load_avatar` ()

Properties¶

Name	Type	Flags
`avatar-url`	`str`	r
`description`	`str`	r
`issues-url`	`str`	r
`merge-requests-url`	`str`	r
`online-url`	`str`	r
`title`	`str`	r

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Foundry.ForgeProject(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Foundry.ForgeProjectClass

Represents a project on a forge.

Plugins can implement this as part of their forge implementation to allow the user to access various forge features related to their project.

New in version 1.1.

dup_avatar_url()¶

Return type:: str or None

New in version 1.1.

dup_description()¶

Return type:: str or None

New in version 1.1.

dup_issues_url()¶

Return type:: str or None

New in version 1.1.

dup_merge_requests_url()¶

Return type:: str or None

New in version 1.1.

dup_online_url()¶

Return type:: str or None

New in version 1.1.

dup_title()¶

Return type:: str or None

New in version 1.1.

list_issues(query)¶

Parameters:: query (Foundry.ForgeQuery or None) –
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.ForgeListing] or rejects with error.
Return type:: Dex.Future

Queries the forge for a list of issues in the project.

New in version 1.1.

list_merge_requests(query)¶

Parameters:: query (Foundry.ForgeQuery or None) –
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.ForgeListing] or rejects with error.
Return type:: Dex.Future

Queries the forge for a list of merge requests in the project.

New in version 1.1.

load_avatar()¶

Returns:: a [class`Dex`.Future] that resolves to a [struct`GLib`.Bytes] or rejects with error.
Return type:: Dex.Future

New in version 1.1.

do_dup_avatar_url() virtual¶

Return type:: str or None

New in version 1.1.

do_dup_description() virtual¶

Return type:: str or None

New in version 1.1.

do_dup_issues_url() virtual¶

Return type:: str or None

New in version 1.1.

do_dup_merge_requests_url() virtual¶

Return type:: str or None

New in version 1.1.

do_dup_online_url() virtual¶

Return type:: str or None

New in version 1.1.

do_dup_title() virtual¶

Return type:: str or None

New in version 1.1.

do_list_issues(query) virtual¶

Parameters:: query (Foundry.ForgeQuery or None) –
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.ForgeListing] or rejects with error.
Return type:: Dex.Future

Queries the forge for a list of issues in the project.

New in version 1.1.

do_list_merge_requests(query) virtual¶

Parameters:: query (Foundry.ForgeQuery or None) –
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.ForgeListing] or rejects with error.
Return type:: Dex.Future

Queries the forge for a list of merge requests in the project.

New in version 1.1.

do_load_avatar() virtual¶

Returns:: a [class`Dex`.Future] that resolves to a [struct`GLib`.Bytes] or rejects with error.
Return type:: Dex.Future

New in version 1.1.

Property Details¶

Foundry.ForgeProject.props.avatar_url¶

Name:: avatar-url
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.ForgeProject.props.description¶

Name:: description
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.ForgeProject.props.issues_url¶

Name:: issues-url
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.ForgeProject.props.merge_requests_url¶

Name:: merge-requests-url
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.ForgeProject.props.online_url¶

Name:: online-url
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.ForgeProject.props.title¶

Name:: title
Type:: str
Default Value:: None
Flags:: READABLE