UtilityModule: TidyModule utility class

In xni7/tidymodules: A robust framework for developing shiny modules

Description

A module used by some of the utility functions to retrieve the ModStore object.

Details

This utility module is a special TidyModule class that doesn't get registered in the ModStore. It is used to retrieve ModStore objects, like sessions and modules.

Super class

tidymodules::TidyModule -> UtilityModule

Methods

Public methods

• UtilityModule$new()

• UtilityModule$clone()

Inherited methods

• tidymodules::TidyModule$addInputPort()

• tidymodules::TidyModule$addOutputPort()

• tidymodules::TidyModule$assignPort()

• tidymodules::TidyModule$callModule()

• tidymodules::TidyModule$countInputPort()

• tidymodules::TidyModule$countOutputPort()

• tidymodules::TidyModule$deepClone()

• tidymodules::TidyModule$definePort()

• tidymodules::TidyModule$doServer()

• tidymodules::TidyModule$execInput()

• tidymodules::TidyModule$execOutput()

• tidymodules::TidyModule$getGlobalSession()

• tidymodules::TidyModule$getInput()

• tidymodules::TidyModule$getInputPort()

• tidymodules::TidyModule$getInputPorts()

• tidymodules::TidyModule$getOutput()

• tidymodules::TidyModule$getOutputPort()

• tidymodules::TidyModule$getOutputPorts()

• tidymodules::TidyModule$getPortDef()

• tidymodules::TidyModule$getPortName()

• tidymodules::TidyModule$getSession()

• tidymodules::TidyModule$getSessionId()

• tidymodules::TidyModule$getShinyInput()

• tidymodules::TidyModule$getShinyOutput()

• tidymodules::TidyModule$getShinySession()

• tidymodules::TidyModule$getStore()

• tidymodules::TidyModule$iport()

• tidymodules::TidyModule$isGlobal()

• tidymodules::TidyModule$isStored()

• tidymodules::TidyModule$ns()

• tidymodules::TidyModule$oport()

• tidymodules::TidyModule$print()

• tidymodules::TidyModule$render()

• tidymodules::TidyModule$reset()

• tidymodules::TidyModule$server()

• tidymodules::TidyModule$ui()

• tidymodules::TidyModule$updateInputPort()

• tidymodules::TidyModule$updateInputPorts()

• tidymodules::TidyModule$updateOutputPort()

• tidymodules::TidyModule$updateOutputPorts()

• tidymodules::TidyModule$use()

• tidymodules::TidyModule$view()

---

Method new()

Initialize function.

Usage

UtilityModule$new()

Returns

UtilityModule object.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

UtilityModule$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
# Print current session Id
UtilityModule$new()$getSessionId()

## End(Not run)

xni7/tidymodules documentation built on Dec. 23, 2021, 7:10 p.m.