interface RocketChatConfigInterface in Rocket.Chat 8.2

Interface to make an Arbitrary storage backend for the config elements.

@package RocketChat

Hierarchy

• interface \Drupal\rocket_chat_api\RocketChat\RocketChatConfigInterface

File

modules/rocket_chat_api/src/RocketChat/RocketChatConfigInterface.php, line 16

Namespace

Drupal\rocket_chat_api\RocketChat

interface RocketChatConfigInterface {

  /**
   * Check if we got everythingto connect to a Client.
   * @return bool
   */
  public function isReady();

  /**
   * Get a RocketChatConfigInterface Element.
   *
   * @param string $elementName
   *   Key value to retrieve from the RocketChatConfigInterface Backend.
   * @param string $default
   *   A possible Default to use when no config is found in the backend.
   *
   * @return mixed
   *   The retrieved config value.
   */
  public function getElement($elementName, $default = NULL);

  /**
   * Set an Element in the RocketChatConfigInterface.
   *
   * @param string $elementName
   *   Key value to set in the RocketChatConfigInterface Backend.
   * @param string $newValue
   *   the new Value to store.
   */
  public function setElement($elementName, $newValue);

  /**
   * Is this a Debug / verbose Run.
   *
   * @return bool
   *   Are we in debug mode?
   */
  public function isDebug();

  /**
   * Get a function pointer to the function to use for JsonDecodeing.
   *
   * @return mixed
   *   Result array
   */
  public function getJsonDecoder();

  /**
   * Notify the backend.
   *
   * @param string $message
   *   Message to report back.
   * @param string $type
   *   Type or Level of the Message.
   *
   * @return mixed
   *   Result of notify on backend.
   */
  public function notify($message, $type);

  /**
   * Log a specific action
   * @param string $message
   *   Message to log.
   * @param mixed $level
   *   any of the valid log levels as defined for \Psr\Log.
   * @return void
   */
  public function log($message, $level);

}

Members

Name	Modifiers	Type	Description	Overrides
RocketChatConfigInterface::getElement	public	function	Get a RocketChatConfigInterface Element.	2
RocketChatConfigInterface::getJsonDecoder	public	function	Get a function pointer to the function to use for JsonDecodeing.	2
RocketChatConfigInterface::isDebug	public	function	Is this a Debug / verbose Run.	2
RocketChatConfigInterface::isReady	public	function	Check if we got everythingto connect to a Client.	2
RocketChatConfigInterface::log	public	function	Log a specific action	2
RocketChatConfigInterface::notify	public	function	Notify the backend.	2
RocketChatConfigInterface::setElement	public	function	Set an Element in the RocketChatConfigInterface.	2