Unity Scopes API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
unity::scopes::ActionMetadata Class Referencefinal

Metadata passed to scopes for preview and activation. More...

#include <unity/scopes/ActionMetadata.h>

Public Member Functions

 ActionMetadata (std::string const &locale, std::string const &form_factor)
 Create ActionMetadata with given locale and form factor. More...
 
std::string locale () const
 Get the locale string. More...
 
std::string form_factor () const
 Get the form factor string. More...
 
void set_scope_data (Variant const &data)
 Attach arbitrary data to this ActionMetadata. More...
 
Variant scope_data () const
 Get data attached to this ActionMetadata. More...
 
Copy and assignment

Copy and assignment operators (move and non-move versions) have the usual value semantics.

 ActionMetadata (ActionMetadata const &other)
 
 ActionMetadata (ActionMetadata &&)
 
ActionMetadataoperator= (ActionMetadata const &other)
 
ActionMetadataoperator= (ActionMetadata &&)
 

Detailed Description

Constructor & Destructor Documentation

unity::scopes::ActionMetadata::ActionMetadata ( std::string const &  locale,
std::string const &  form_factor 
)

Create ActionMetadata with given locale and form factor.

Parameters
localelocale string, eg. en_EN
form_factorform factor name, e.g. phone, desktop, phone-version etc.

Member Function Documentation

std::string unity::scopes::ActionMetadata::form_factor ( ) const

Get the form factor string.

Returns
The form factor string
std::string unity::scopes::ActionMetadata::locale ( ) const

Get the locale string.

Returns
The locale string
Variant unity::scopes::ActionMetadata::scope_data ( ) const

Get data attached to this ActionMetadata.

Returns
The attached data, or Variant::null.
void unity::scopes::ActionMetadata::set_scope_data ( Variant const &  data)

Attach arbitrary data to this ActionMetadata.

Parameters
dataThe data value to attach.

The documentation for this class was generated from the following files: