Foundry.DocumentationBundle¶

Subclasses:: None

Methods¶

Inherited:: Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)
Structs:: GObject.ObjectClass (5)

	`dup_id` ()
	`dup_subtitle` ()
	`dup_tags` ()
	`dup_title` ()
	`get_eol` ()
	`get_installed` ()
	`install` (operation, cancellable)

Virtual Methods¶

Inherited:: GObject.Object (7), Json.Serializable (5)

	`do_dup_id` ()
	`do_dup_subtitle` ()
	`do_dup_tags` ()
	`do_dup_title` ()
	`do_get_eol` ()
	`do_get_installed` ()
	`do_install` (operation, cancellable)

Properties¶

Inherited:: Foundry.Contextual (1)

Name	Type	Flags
`eol`	`bool`	r
`id`	`str`	r
`installed`	`bool`	r
`subtitle`	`str`	r
`title`	`str`	r

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Foundry.Contextual`	r

Class Details¶

class Foundry.DocumentationBundle(**kwargs)¶

Bases:: Foundry.Contextual
Abstract:: Yes
Structure:: Foundry.DocumentationBundleClass

Abstract base class for plugins to provide installable documentation.

A bundle represents a group of documentation that may be installed such as the docs for a specific SDK.

dup_id()¶

Return type:: str

dup_subtitle()¶

Return type:: str or None

dup_tags()¶

Return type:: [str] or None

Gets tags for the documentation which may be useful to show the user to help them make better selections.

dup_title()¶

Return type:: str

get_eol()¶

Returns:: True if the bundle has reached end of life, False otherwise
Return type:: bool

Gets whether the documentation bundle has reached end of life.

New in version 1.1.

get_installed()¶

Return type:: bool

install(operation, cancellable)¶

Parameters:

operation (Foundry.Operation) – a [class`Foundry`.Operation] to be updated by the provider
cancellable (Dex.Cancellable) –

Returns:

a [class`Dex`.Future] that resolves to any value or rejects with error.

Return type:

Dex.Future

do_dup_id() virtual¶

Return type:: str

do_dup_subtitle() virtual¶

Return type:: str or None

do_dup_tags() virtual¶

Return type:: [str] or None

Gets tags for the documentation which may be useful to show the user to help them make better selections.

do_dup_title() virtual¶

Return type:: str

do_get_eol() virtual¶

Returns:: True if the bundle has reached end of life, False otherwise
Return type:: bool

Gets whether the documentation bundle has reached end of life.

New in version 1.1.

do_get_installed() virtual¶

Return type:: bool

do_install(operation, cancellable) virtual¶

Parameters:

operation (Foundry.Operation) – a [class`Foundry`.Operation] to be updated by the provider
cancellable (Dex.Cancellable) –

Returns:

a [class`Dex`.Future] that resolves to any value or rejects with error.

Return type:

Dex.Future

Property Details¶

Foundry.DocumentationBundle.props.eol¶

Name:: eol
Type:: bool
Default Value:: False
Flags:: READABLE

Whether the documentation bundle has reached end of life.

New in version 1.1.

Foundry.DocumentationBundle.props.id¶

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

Foundry.DocumentationBundle.props.installed¶

Name:: installed
Type:: bool
Default Value:: False
Flags:: READABLE

Foundry.DocumentationBundle.props.subtitle¶

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

Foundry.DocumentationBundle.props.title¶

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