• Publicity: Public Only All

chat-procs.tcl

TCL Library for the chat system v.6 These procs serve now only as a backward compatibility layer, as all the relevant logic is implemented in xotcl-chat-procs. These procs will soon be deprecated.

Location:
packages/chat/tcl/chat-procs.tcl
Created:
November 17, 2000
Author:
David Dao <ddao@arsdigita.com>
CVS Identification:
$Id: chat-procs.tcl,v 1.24.2.10 2023/03/29 15:33:33 antoniop Exp $

Procedures in this file

Detailed information

chat_message_count (public, deprecated)

 chat_message_count room_id
Deprecated. Invoking this procedure generates a warning.

Get message count in the room.

Parameters:
room_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_message_count chat_message_count chat_message_count->ad_log_deprecated

Testcases:
No testcase defined.

chat_message_post (public, deprecated)

 chat_message_post room_id user_id message moderator_p
Deprecated. Invoking this procedure generates a warning.

Post message to the chat room and broadcast to all applet clients. Used by ajax + html.

Parameters:
room_id (required)
user_id (required)
message (required)
moderator_p (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_message_post chat_message_post chat_message_post->ad_log_deprecated

Testcases:
No testcase defined.

chat_moderator_grant (public, deprecated)

 chat_moderator_grant room_id party_id
Deprecated. Invoking this procedure generates a warning.

Grant party a chat moderate privilege to this chat room.

Parameters:
room_id (required)
party_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_moderator_grant chat_moderator_grant chat_moderator_grant->ad_log_deprecated

Testcases:
No testcase defined.

chat_moderator_revoke (public, deprecated)

 chat_moderator_revoke room_id party_id
Deprecated. Invoking this procedure generates a warning.

Revoke party a chat moderate privilege to this chat room.

Parameters:
room_id (required)
party_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_moderator_revoke chat_moderator_revoke chat_moderator_revoke->ad_log_deprecated

Testcases:
No testcase defined.

chat_revoke_moderators (public, deprecated)

 chat_revoke_moderators room_id revoke_list
Deprecated. Invoking this procedure generates a warning.

Revoke a list of parties of a moderate privilege from this room.

Parameters:
room_id (required)
revoke_list (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_revoke_moderators chat_revoke_moderators chat_revoke_moderators->ad_log_deprecated

Testcases:
No testcase defined.

chat_room_delete (public, deprecated)

 chat_room_delete room_id
Deprecated. Invoking this procedure generates a warning.

Delete chat room.

Parameters:
room_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_room_delete chat_room_delete chat_room_delete->ad_log_deprecated

Testcases:
No testcase defined.

chat_room_edit (public, deprecated)

 chat_room_edit room_id pretty_name description moderated_p active_p \
    archive_p auto_flush_p auto_transcript_p login_messages_p \
    logout_messages_p messages_time_window avatar_p
Deprecated. Invoking this procedure generates a warning.

Edit information on chat room. All information require.

Parameters:
room_id (required)
pretty_name (required)
description (required)
moderated_p (required)
active_p (required)
archive_p (required)
auto_flush_p (required)
auto_transcript_p (required)
login_messages_p (required)
logout_messages_p (required)
messages_time_window (required)
avatar_p (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_room_edit chat_room_edit chat_room_edit->ad_log_deprecated

Testcases:
No testcase defined.

chat_room_exists_p (public, deprecated)

 chat_room_exists_p room_id
Deprecated. Invoking this procedure generates a warning.

Return whether a chat room exists

Parameters:
room_id (required)
Returns:
a boolean
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_room_exists_p chat_room_exists_p chat_room_exists_p->ad_log_deprecated

Testcases:
No testcase defined.

chat_room_get (public, deprecated)

 chat_room_get [ -room_id room_id ] -array array
Deprecated. Invoking this procedure generates a warning.

Get all the information about a chat room into an array

Switches:
-room_id (optional)
-array (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_room_get_not_cached chat_room_get_not_cached (private, deprecated) chat_room_get chat_room_get chat_room_get->ad_log_deprecated chat_room_get->chat_room_get_not_cached

Testcases:
No testcase defined.

chat_room_message_delete (public, deprecated)

 chat_room_message_delete room_id
Deprecated. Invoking this procedure generates a warning.

Delete all message in the room.

Parameters:
room_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_room_message_delete chat_room_message_delete chat_room_message_delete->ad_log_deprecated

Testcases:
No testcase defined.

chat_room_moderate_p (public, deprecated)

 chat_room_moderate_p room_id
Deprecated. Invoking this procedure generates a warning.

Return the moderate status of this chat room. Note that the moderated_p flag is not part of the current datamodel anymore.

Parameters:
room_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_room_moderate_p chat_room_moderate_p chat_room_moderate_p->ad_log_deprecated

Testcases:
No testcase defined.

chat_room_name (public, deprecated)

 chat_room_name room_id
Deprecated. Invoking this procedure generates a warning.

Get chat room name.

Parameters:
room_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_room_name chat_room_name chat_room_name->ad_log_deprecated

Testcases:
No testcase defined.

chat_room_new (public, deprecated)

 chat_room_new [ -description description ] \
    [ -moderated_p moderated_p ] [ -active_p active_p ] \
    [ -archive_p archive_p ] [ -auto_flush_p auto_flush_p ] \
    [ -auto_transcript_p auto_transcript_p ] \
    [ -login_messages_p login_messages_p ] \
    [ -logout_messages_p logout_messages_p ] \
    [ -messages_time_window messages_time_window ] \
    [ -context_id context_id ] [ -creation_user creation_user ] \
    [ -creation_ip creation_ip ] [ -avatar_p avatar_p ] pretty_name
Deprecated. Invoking this procedure generates a warning.

Create new chat room. Return room_id if successful else raise error.

Switches:
-description (optional)
-moderated_p (optional, defaults to "f")
-active_p (optional, defaults to "t")
-archive_p (optional, defaults to "f")
-auto_flush_p (optional, defaults to "t")
-auto_transcript_p (optional, defaults to "f")
-login_messages_p (optional, defaults to "t")
-logout_messages_p (optional, defaults to "t")
-messages_time_window (optional, defaults to "600")
-context_id (optional)
-creation_user (optional)
-creation_ip (optional)
-avatar_p (optional, defaults to "t")
Parameters:
pretty_name (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_room_new chat_room_new chat_room_new->ad_log_deprecated

Testcases:
No testcase defined.

chat_transcript_delete (public, deprecated)

 chat_transcript_delete transcript_id
Deprecated. Invoking this procedure generates a warning.

Delete chat transcript.

Parameters:
transcript_id (required)
See Also:
  • xo::db::chat_transcript

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_transcript_delete chat_transcript_delete chat_transcript_delete->ad_log_deprecated

Testcases:
No testcase defined.

chat_transcript_edit (public, deprecated)

 chat_transcript_edit transcript_id pretty_name description contents
Deprecated. Invoking this procedure generates a warning.

Edit chat transcript.

Parameters:
transcript_id (required)
pretty_name (required)
description (required)
contents (required)
See Also:
  • xo::db::chat_transcript

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_transcript_edit chat_transcript_edit chat_transcript_edit->ad_log_deprecated

Testcases:
No testcase defined.

chat_transcript_new (public, deprecated)

 chat_transcript_new [ -description description ] \
    [ -context_id context_id ] [ -creation_user creation_user ] \
    [ -creation_ip creation_ip ] pretty_name contents room_id
Deprecated. Invoking this procedure generates a warning.

Create chat transcript.

Switches:
-description (optional)
-context_id (optional)
-creation_user (optional)
-creation_ip (optional)
Parameters:
pretty_name (required)
contents (required)
room_id (required)
See Also:
  • xo::db::chat_transcript

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_transcript_new chat_transcript_new chat_transcript_new->ad_log_deprecated

Testcases:
No testcase defined.

chat_user_ban (public, deprecated)

 chat_user_ban room_id party_id
Deprecated. Invoking this procedure generates a warning.

Explicit ban user from this chat room.

Parameters:
room_id (required)
party_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_user_ban chat_user_ban chat_user_ban->ad_log_deprecated

Testcases:
No testcase defined.

chat_user_grant (public, deprecated)

 chat_user_grant room_id party_id
Deprecated. Invoking this procedure generates a warning.

Grant party a chat privilege to this chat room.

Parameters:
room_id (required)
party_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_user_grant chat_user_grant chat_user_grant->ad_log_deprecated

Testcases:
No testcase defined.

chat_user_name (public, deprecated)

 chat_user_name user_id
Deprecated. Invoking this procedure generates a warning.

Return display name of this user to use in chat.

Parameters:
user_id (required)
See Also:
  • chat::Package

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_user_name chat_user_name chat_user_name->ad_log_deprecated

Testcases:
No testcase defined.

chat_user_revoke (public, deprecated)

 chat_user_revoke room_id party_id
Deprecated. Invoking this procedure generates a warning.

Revoke party a chat privilege to this chat room.

Parameters:
room_id (required)
party_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_user_revoke chat_user_revoke chat_user_revoke->ad_log_deprecated

Testcases:
No testcase defined.

chat_user_unban (public, deprecated)

 chat_user_unban room_id party_id
Deprecated. Invoking this procedure generates a warning.

unban user from this chat room.

Parameters:
room_id (required)
party_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) chat_user_unban chat_user_unban chat_user_unban->ad_log_deprecated

Testcases:
No testcase defined.

room_active_status (public, deprecated)

 room_active_status room_id
Deprecated. Invoking this procedure generates a warning.

Get room active status.

Parameters:
room_id (required)
See Also:
  • xo::db::chat_room

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) room_active_status room_active_status room_active_status->ad_log_deprecated

Testcases:
No testcase defined.
[ show source ]