NavNode
- enum q2_sdk.hq.db.nav_node.NavigationType(value)[source]
Bases:
IntEnum
- Member Type:
Valid values are as follows:
- StandardMenu = <NavigationType.StandardMenu: 1>
- MobileThumbBar = <NavigationType.MobileThumbBar: 2>
- NavLandingPage = <NavigationType.NavLandingPage: 3>
- class q2_sdk.hq.db.nav_node.CentralNavMenu(nodes)[source]
Bases:
object
- class q2_sdk.hq.db.nav_node.NavMenu(nodes)[source]
Bases:
object
- update_node(nav_node_id, ui_text, route, order, css_class=None, parent_nav_node_id=None, form_id=None, navigation_type_id=None)[source]
- property top_level_nodes: List[Element]
Nodes with null ParentNavigationNodeIds ordered by the Order column
- class q2_sdk.hq.db.nav_node.NavNodeRow(element, row_class=None, rename_fields=None)[source]
Bases:
TableRow
- class q2_sdk.hq.db.nav_node.CentralNavNodeRow(element, row_class=None, rename_fields=None)[source]
Bases:
TableRow
- class q2_sdk.hq.db.nav_node.NavNode(logger, hq_credentials=None, ret_table_obj=None)[source]
Bases:
DbObject
Programmatic access to the Q2 database. Not as flexible as a true ORM, but takes the guesswork out of database schemas and ensures safety in the transactions.
- Parameters:
logger – Reference to calling request’s logger (self.logger in your extension)
hq_credentials (
Optional
[HqCredentials
]) – HQ Connectivity Information (Defaults to settings file)ret_table_obj (
bool
|None
) – Flag to return list of LXML elements ifFalse
or TableRow objects from DB calls ifTrue
(Defaults to settings file)
- GET_BY_NAME_KEY = 'ShortName'
- NAME = 'NavigationNode'
- REPRESENTATION_ROW_CLASS
alias of
NavNodeRow
- AVAILABLE_ICONS = ['landing-page', 'message-center', 'transactions', 'payments', 'commercial', 'branches', 'services', 'news', 'reports', 'settings', 'help', 'logoff']
- async get(parent_nav_node_id=None, serialize_for_cli=False)[source]
Returns a list of NavNode Elements
- Return type:
- async get_central(parent_nav_node_id=None, serialize_for_cli=False)[source]
Returns a list of NavNode Elements
- Return type:
- async create(navigation_style_id, route, order, short_name, ui_text_element_id, parent_nav_node_id=None, css_class=None, form_id=None, property_id=None, route_parameters=None, vendor_id=None, sso_iframe_option=False, device_bit_flag=7, enabled=True, navigation_id=1, navigation_type_id=1, available_for_landing=False)[source]
- async update(navigation_node_id, ui_text, route, order, css_class=<DEFAULT_DB_PARAM>, parent_navigation_node=<DEFAULT_DB_PARAM>, device_bit_flag=<DEFAULT_DB_PARAM>, route_parameters=<DEFAULT_DB_PARAM>, form_id=<DEFAULT_DB_PARAM>, vendor_id=<DEFAULT_DB_PARAM>, enabled=<DEFAULT_DB_PARAM>, dyn_nav_window_features_id=<DEFAULT_DB_PARAM>, property_id=<DEFAULT_DB_PARAM>, navigation_id=<DEFAULT_DB_PARAM>, navigation_type_id=<DEFAULT_DB_PARAM>, available_for_landing=<DEFAULT_DB_PARAM>, **kwargs)[source]