SourceStatus

Module: Core

This class represents the status of a DAB source during a discover

Index
Methods
Properties

Item Index

Methods

id
message
phase
progress
title

Properties

COMPLETED_DATA_URL
DECODING_REQUEST_DATA_URL
DECODING_RESPONSE_DATA_URL
DISTRIBUTION_DATA_URL
ERROR_DATA_URL
INIT_DATA_URL
JOIN_DATA_URL
NETWORK_WAITING_DATA_URL
PROCESSING_DATA_URL
TIMEOUT_DATA_URL
VALIDATION_DATA_URL

Methods

`id`

() String

Retrieves the report id of this source

Returns:

String:

A String with the report id of this source

`message`

() String

Retrieves a message describing the current activity of this source

Returns:

String:

A message describing the current activity of this source

`phase`

(

[dataURL=false]

)

String

Retrieves the name of phase of completion (default) or a data URL of a correspondent predefined icon

Parameters:

[dataURL=false] Boolean optional

If omitted or set to false returns the name of the phase of completion, otherwise returns the data URL of a correspondent predefined icon as depicted in the following table:

Phase description	Phase name (`dataURL` omitted or set to `false`)	Phase as data URL (`dataURL` set to `true`)
Query initialization	"INIT"	INIT_DATA_URL
Distribution of the query to the sources	"DISTRIBUTION"	DISTRIBUTION_DATA_URL
Query validation	"VALIDATION"	VALIDATION_DATA_URL
Query decoding	"DECODING_REQUEST"	DECODING_REQUEST_DATA_URL
Waiting response from the source	"NETWORK_WAITING"	NETWORK_WAITING_DATA_URL
Collecting sources responses	"JOIN"	JOIN_DATA_URL
Processing response	"PROCESSING"	PROCESSING_DATA_URL
Response decoding	"DECODING_RESPONSE"	DECODING_RESPONSE_DATA_URL
Query completed	"COMPLETED"	COMPLETED_DATA_URL
Error occurred	"ERROR"	ERROR_DATA_URL
Source unreachable	"TIMEOUT"	TIMEOUT_DATA_URL

Returns:

String:

A String with the name of the phase of completion or a data URL of a correspondent predefined icon

`progress`

() Integer

Retrieves the percentage of completion of this source

Returns:

Integer:

The percentage of completion of this source

`title`

() String

Retrieves the report title of this source

Returns:

String:

A String with the report title of this source

Properties

`COMPLETED_DATA_URL`

String

Icon data URL of the "COMPLETED" phase

`DECODING_REQUEST_DATA_URL`

String

Icon data URL of the "DECODING_REQUEST" phase

`DECODING_RESPONSE_DATA_URL`

String

Icon data URL of the "DECODING_RESPONSE" phase

`DISTRIBUTION_DATA_URL`

String

Icon data URL of the "DISTRIBUTION" phase

`ERROR_DATA_URL`

String

Icon data URL of the "ERROR" phase

`INIT_DATA_URL`

String

Icon data URL of the "INIT" phase

`JOIN_DATA_URL`

String

Icon data URL of the "JOIN" phase

`NETWORK_WAITING_DATA_URL`

String

Icon data URL of the "NETWORK_WAITING" phase

`PROCESSING_DATA_URL`

String

Icon data URL of the "PROCESSING" phase

`TIMEOUT_DATA_URL`

String

Icon data URL of the "TIMEOUT" phase

`VALIDATION_DATA_URL`

String

Icon data URL of the "VALIDATION" phase