Function __global->_chat_messages_script_ajax

Definitions

sources/chat.php

  • Output messages (in XML format) from up to five minutes ago (give somebody who's just joined the chatroom some chat backlog), or the messages posted since the last check.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$room_id AUTO_LINK No No required parameter N/A N/A Room ID (or -1 to mean 'all' as used for IM global process, -2 to mean none)
$backlog boolean No No False N/A N/A Output the backlog?
$message_id ?AUTO_LINK No No Null N/A N/A Latest received message ID (null: we're not getting latest messages)
$event_id ?AUTO_LINK No No Null N/A N/A Latest event ID (null: we're not getting events, but we do request a null event so we can use that as a future reference point)
$events_output string No No Blank (empty string) N/A N/A Events output to append

Preview

Code (PHP)

/**
 * Output messages (in XML format) from up to five minutes ago (give somebody who's just joined the chatroom some chat backlog), or the messages posted since the last check.
 *
 * @param  AUTO_LINK $room_id Room ID (or -1 to mean 'all' as used for IM global process, -2 to mean none)
 * @param  boolean $backlog Output the backlog?
 * @param  ?AUTO_LINK $message_id Latest received message ID (null: we're not getting latest messages)
 * @param  ?AUTO_LINK $event_id Latest event ID (null: we're not getting events, but we do request a null event so we can use that as a future reference point)
 * @param  string $events_output Events output to append
 */
function _chat_messages_script_ajax(int $room_id, bool $backlog = false, ?int $message_id = null, ?int $event_id = null, string $events_output = '')