mirror of
https://github.com/zulip/zulip.git
synced 2025-11-10 00:46:03 +00:00
5c220ed11a
The real purpose these two callbacks serve is exactly what an ordinary parameter is perfect for: * Each has just one call site, at the top of the function. * They're not done for side effects; the point is what they return. * The function doesn't pass them any arguments of its own, or otherwise express any internal knowledge that doesn't just as properly belong to its caller. So, push the calls to these callbacks up into the function's caller, and pass in the data they return instead. This greatly simplifies the interface of `handle_text_input` and of `typing_status` in general.
105 lines
2.9 KiB
JavaScript
105 lines
2.9 KiB
JavaScript
const typing_status = require("../shared/js/typing_status");
|
|
|
|
var typing = (function () {
|
|
var exports = {};
|
|
|
|
// This module handles the outbound side of typing indicators.
|
|
// We detect changes in the compose box and notify the server
|
|
// when we are typing. For the inbound side see typing_events.js.
|
|
//
|
|
// See docs/subsystems/typing-indicators.md for details on typing indicators.
|
|
|
|
function send_typing_notification_ajax(user_ids_array, operation) {
|
|
channel.post({
|
|
url: '/json/typing',
|
|
data: {
|
|
to: JSON.stringify(user_ids_array),
|
|
op: operation,
|
|
},
|
|
success: function () {},
|
|
error: function (xhr) {
|
|
blueslip.warn("Failed to send typing event: " + xhr.responseText);
|
|
},
|
|
});
|
|
}
|
|
|
|
function get_user_ids_array() {
|
|
var user_ids_string = compose_pm_pill.get_user_ids_string();
|
|
if (user_ids_string === "") {
|
|
return;
|
|
}
|
|
|
|
return people.user_ids_string_to_ids_array(user_ids_string);
|
|
}
|
|
|
|
function is_valid_conversation(user_ids_array) {
|
|
// TODO: Check to make sure we're in a PM conversation
|
|
// with valid emails.
|
|
if (!user_ids_array) {
|
|
return false;
|
|
}
|
|
|
|
if (compose_pm_pill.has_unconverted_data()) {
|
|
return true;
|
|
}
|
|
|
|
var compose_empty = !compose_state.has_message_content();
|
|
if (compose_empty) {
|
|
return false;
|
|
}
|
|
|
|
if (compose_state.get_message_type() !== 'private') {
|
|
// We only use typing indicators in PMs for now.
|
|
// There was originally some support for having
|
|
// typing indicators related to stream conversations,
|
|
// but the initial rollout led to users being
|
|
// confused by them. We may revisit this.
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
function get_current_time() {
|
|
return new Date().getTime();
|
|
}
|
|
|
|
function notify_server_start(user_ids_array) {
|
|
send_typing_notification_ajax(user_ids_array, "start");
|
|
}
|
|
|
|
function notify_server_stop(user_ids_array) {
|
|
send_typing_notification_ajax(user_ids_array, "stop");
|
|
}
|
|
|
|
exports.get_recipient = get_user_ids_array;
|
|
exports.initialize = function () {
|
|
var worker = {
|
|
get_current_time: get_current_time,
|
|
notify_server_start: notify_server_start,
|
|
notify_server_stop: notify_server_stop,
|
|
};
|
|
|
|
$(document).on('input', '#compose-textarea', function () {
|
|
// If our previous state was no typing notification, send a
|
|
// start-typing notice immediately.
|
|
var new_recipient = exports.get_recipient();
|
|
typing_status.handle_text_input(
|
|
worker, new_recipient, is_valid_conversation(new_recipient));
|
|
});
|
|
|
|
// We send a stop-typing notification immediately when compose is
|
|
// closed/cancelled
|
|
$(document).on('compose_canceled.zulip compose_finished.zulip', function () {
|
|
typing_status.stop(worker);
|
|
});
|
|
};
|
|
|
|
return exports;
|
|
}());
|
|
|
|
if (typeof module !== 'undefined') {
|
|
module.exports = typing;
|
|
}
|
|
window.typing = typing;
|