obs-master QML Type

The main UI front-end of OBS Master More...

Import Statement: import org.nephros.sailfish.OBSMaster 1.0

List of all members, including inherited members

Properties

busy : alias
chumRoot : string
chumTestingRoot : string
homeProject : string
hostArch : string
initialized : alias
logsizeLimit : alias
obsPackage : alias
obsProject : alias
offline : bool
online : alias
showrss : alias
sizeLimit : int
startDir : string
workDir : string
workDirShort : string

Methods

addRepo(projectName, repository)
clearSettings()
doWorkDirChange()
isArchValid(arch)
popup(s)
readFile(url, callBack)

Detailed Description

For documentation on how to use the application, see the User Guide

DBus-Interface

OBSMaster provides a DBus interface to control it from somewhere else.

Interface

bus	session bus
service	`org.nephros.sailfish.OBSMaster`
interface	`org.nephros.sailfish.OBSMaster`
path	`/org/nephros/sailfish/OBSMaster`

Properties, Methods, and Signals

The following properties and methods are available (in addition to the standard Open and Activate calls:

type	name	arguments	return values	notes
Property	ready	n/a	`bool`	`true` if the interface is ready to respond to method calls. Users of the interface should check this property before issuing any calls.
Method	loadProject	`s` projectname	none	Retrieve project data corresponding to `projectname` from OBS server
Method	loadPackage	`ss` projectname packagename	none	Retrieve package data corresponding to `projectname`, `packagename` from OBS server
Method	openProjectDir	`s` url	none	Switch working directory to `url` and load local project information
Method	openPackageDir	`s` url	none	Switch working directory to `url` and load local project and package information

For example, one might switch the working directory locally by doing:

 busctl --user call org.nephros.sailfish.OBSMaster /org/nephros/sailfish/OBSMaster org.nephros.sailfish.OBSMaster openProjectDir s file:///home/nemo/devel/obs/sailfishos:chum

Or load information about a remote package like this:

 busctl --user call org.nephros.sailfish.OBSMaster /org/nephros/sailfish/OBSMaster org.nephros.sailfish.OBSMaster loadPackage ss sailfishos:chum obs-master

Property Documentation

busy : alias

chumRoot : string

Persistent storage for the file-system location treated as working directory for the SailfishOS::Chum project

Value is auto-detected when the working directory looks like a chum directory. Can be reset in Settings.

chumTestingRoot : string

Persistent storage for the file-system location treated as working directory for the SailfishOS:Chum:Testing project

Value is auto-detected when the working directory looks like a chum testing directory. Can be reset in Settings.

homeProject : string

The configuration entry storing the Project selection dialogs will start at for remote Project selection.

Defaults to home:user and can be modified in Settings.

hostArch : string

Arch of the host we are running on. Used to check whether adding repositories should be offered

initialized : alias

logsizeLimit : alias

obsPackage : alias

obsProject : alias

offline : bool

online : alias

showrss : alias

sizeLimit : int

The configuration entry storing the user's size limit preference.

startDir : string

The configuration entry storing the Project selection dialogs will start at.

This assumes users will have their working directory at something like ~/devel/obs/home and will find it convenient to always start selection from there.

Defaults to StandardPaths.home and can be modified in Settings.

workDir : string

The current working directory.

This path is scrutinized by various functions in OBS to determine package and project, current local and remote files etc.

Changes to it are also used to store it persistently for the next app launch.

[read-only] workDirShort : string

Short display version of the startDir (Basically only replace /home/foo with ~).

Method Documentation

addRepo(projectName, repository)

Adds a new (user) repository to the system.

Name and URL are computed from projectName and repository parameters.

This is e.g. used from the results page, or the OBS Master DBus Interface

Note: It is implemented here because we already import Nemo.DBus for other reasons.

clearSettings()

Clears or resets all configuration settings

See also SettingsPage.

doWorkDirChange()

custom signal handler for onWorkDirChanged. delay handling the signal until after all components are ready.

isArchValid(arch)

Returns true if arch is applicable for the arch of the system OBS Master is running on.

Show message s using a popup notification

readFile(url, callBack)

Reads a file via XMLHttpRequest from url, when done execute callBack(result) on it. Intended as a helper function for reading small local files.

Contents