Class ::xowiki::includelet::chat

::xowiki::includelet::chat[i] create ... \
           [ -parameter_declaration (default " {-title ""} {-chat_id ""} {-mode ""} {-path ""} -skin -login_messages_p -logout_messages_p -avatar_p -timewindow ") ]

Include a chat in the current page
Documented Parameters:
mode
path
skin
title
chat_id
avatar_p
login_messages_p
logout_messages_p
timewindow
Defined in packages/xowiki/tcl/includelet-procs.tcl

Class Relations

  • class: ::xowiki::IncludeletClass[i]
  • superclass: ::xowiki::Includelet[i]
::xowiki::IncludeletClass create ::xowiki::includelet::chat \
     -superclass ::xowiki::Includelet

Methods (to be applied on instances)

  • parameter_declaration (setter)

  • render (scripted)

    :get_parameters
    if {$chat_id eq ""} {
      # make the chat just for including page
      set chat_id [${:__including_page} item_id]
    }
    set chat_cmd [list  ::xowiki::Chat login  -chat_id $chat_id  -mode $mode  -path $path]
    # We don't want to override Chat class default with our own and
    # therefore we build the command dynamically depending if these
    # variables are there or not.
    set optional_vars [list login_messages_p logout_messages_p timewindow skin avatar_p]
    foreach var $optional_vars {
      if {[info exists $var]} {
        lappend chat_cmd -${var} [set $var]
      }
    }
    set r [{*}$chat_cmd]
    
    #ns_log notice chat=>$r
    
    return $r