CategorisedResult Class
A result, including the category it belongs to.
Item Index
Methods
art
()
String
Get the "art" property of this Result. This method returns an empty string if this attribute is not of type String.
Returns:
The value of "art" or the empty string.
category
()
Category
Get the category instance this result belongs to.
Returns:
The category instance.
contains
-
key
Check if this Result has an attribute.
Parameters:
-
key
ObjectThe attribute name.
Returns:
True if the attribute is set.
direct_activation
()
Boolean
Check if this result should be activated directly by the shell because the scope doesn't handle activation of this result.
Returns:
True if this result needs to be activated directly.
dnd_uri
()
String
Get the "dnd_uri" property of this Result. This method returns an empty string if this attribute is not of type String.
Returns:
The value of "dnd_uri" or the empty string.
get
-
key
Gets the value of a custom metadata attribute.
Parameters:
-
key
StringThe name of the attribute.
Returns:
Attribute value or null
has_stored_result
()
Boolean
Check if this Result instance has a stored result.
Returns:
True if there is a stored result
is_account_login_result
()
Boolean
Check if this result is an online account login result.
Returns:
True if this result is an online account login result.
set
-
key
-
value
Sets the value of a custom metadata attribute.
Parameters:
-
key
StringThe name of the attribute.
-
value
ObjectThe value of the attribute.
set_art
-
art
Set the "art" attribute of this result.
Parameters:
-
art
String
set_category
-
category
Updates the category of this result.
Parameters:
-
category
ObjectThe category for the result.
set_dnd_uri
-
dnd_uri
Set the "dnd_uri" attribute of this result.
Parameters:
-
dnd_uri
String
set_intercept_activation
()
Indicates to the receiver that this scope should intercept activation requests for this result. By default, a scope receives preview requests for the results it creates, but does not receive activation requests (they are handled directly by the shell). Intercepting activation implies intercepting preview requests as well; this is important for scopes that forward results from other scopes and call set_intercept_activation() on these scopes. A scope that sets intercept activation flag for a result should re-implement Scope.activate() and provide an implementation of ActivationQuery that handles the actual activation. If not called, the result will be activated directly by the Unity shell whithout involving the scope, assuming an appropriate URI schema handler is present on the system.
set_title
-
title
Set the "title" attribute of this result.
Parameters:
-
title
String
set_uri
-
uri
Set the "uri" attribute of this result.
Parameters:
-
uri
String
store
-
The
-
intercept_activation
This method is meant to be used by aggregator scopes which want to modify results they receive, but want to keep a copy of the original result so that they can be correctly handled by the original scopes who created them when it comes to activation or previews. Scopes middleware will automatically pass the correct inner stored result to the activation or preview request handler
Parameters:
-
The
Resultoriginal result to store within this result.
-
intercept_activation
BooleanTrue if this scope should receive activation and preview requests.
title
()
String
Get the "title" property of this Result. This method returns an empty string if this attribute is not of type String.
Returns:
The value of "title" or the empty string.
uri
()
String
Get the "uri" property of this Result. This method returns an empty string if this attribute is not of type String.
Returns:
The value of "uri" or the empty string.