UserReportData¶

class UserReportData¶

AppendEntry(name, value=None, description=None)¶

Appends a new entry. If a entry with the same name already exists, it will be overwritten.

Parameters:

name : str¶: Name of the entry
value : str¶: Value of the entry
description : str¶: Description of the entry

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:: A copy of this object
Return type:: UserReportData

GetAllEntryNames()¶

Returns a list of all entry names.

Returns:: List of all entry names
Return type:: list[str]

GetDescription(name)¶

Returns the description of the entry specified by the given name.

Parameters:

name : str¶: Name of the entry

Returns:

Description text

Return type:

str

GetValue(name)¶

Returns the value of the entry specified by the given name.

Parameters:

name : str¶: Name of the entry

Returns:

Value of the entry

Return type:

str

Raises:

ApiError – If the entry with the given name does not exist

RemoveEntry(name)¶

Removes the entry specified by the given name.

Parameters:

name : str¶: Name of the entry

Returns:

True if successful. False if no entry with such name exists.

Return type:

boolean

SetDescription(name, description)¶

Sets the description of the entry specified by the given name.

Parameters:

name : str¶: Name of the entry
description : str¶: Description text

Raises:

ApiError – If the entry with the given name does not exist
ApiError – If description is no str

SetValue(name, value)¶

Sets the value of the entry specified by the given name.

Parameters:

name : str¶: Name of the entry
value : str¶: Value of the entry

Raises:

ApiError – If the entry with the given name does not exist