- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables
Class ::xo::db::chat_room
::xo::db::chat_roomcreate ...
Defined in
Class Relations
Methods (to be applied on instances)
ban_user (scripted, public)
<instance of xo::db::chat_room> ban_user -party_id party_id
Bans specified user from the chat room
- Switches:
- -party_id (required)
- Testcases:
- chat_room_tests
count_messages (scripted, public)
<instance of xo::db::chat_room> count_messages
Count messages currently persisted for this chat room.
- Testcases:
- chat_room_tests
create_transcript (scripted, public)
<instance of xo::db::chat_room> create_transcript \ [ -pretty_name pretty_name ] [ -description description ] \ [ -creation_user creation_user ] [ -creation_ip creation_ip ]
Creates a new transcript of all current chat room messages.
- Switches:
- -pretty_name (optional)
- -description (optional)
- -creation_user (optional)
- -creation_ip (optional)
- Returns:
- transcript_id of the new transcript or 0 when no messages were in the chat room.
- Testcases:
- chat_room_tests
delete (scripted, public)
<instance of xo::db::chat_room> delete args [ args... ]
Delete the chat room and all of its transcripts
- Parameters:
- args (required)
- Testcases:
- chat_room_tests
delete_messages (scripted, public)
<instance of xo::db::chat_room> delete_messages
Delete all persisted messages from the chat room.
- Testcases:
- chat_room_tests
flush (scripted, public)
<instance of xo::db::chat_room> flush
Save all currently persisted messages for this chat room as a new transcript and then delete them.
- Testcases:
- chat_room_tests
grant_creator (scripted, public)
<instance of xo::db::chat_room> grant_creator
Grants operative privileges to the chat creator (when available on the chat room object). In detail the permissions to edit, view and delete the chat room and also to create transcripts of it.
- Testcases:
- chat_room_tests
grant_moderator (scripted, public)
<instance of xo::db::chat_room> grant_moderator \ -party_id party_id
Make specified party the chat room moderator
- Switches:
- -party_id (required)
- Testcases:
- chat_room_tests
grant_user (scripted, public)
<instance of xo::db::chat_room> grant_user -party_id party_id
Grants operative privileges to the specified party. In detail, the permission to read and write for the chat room.
- Switches:
- -party_id (required)
- Testcases:
- chat_room_tests
post_message (scripted, public)
<instance of xo::db::chat_room> post_message [ -msg msg ] \ [ -creation_user creation_user ] [ -creation_ip creation_ip ]
Post a message in the chat room. This actually means persisting the message in the database, but only if the chat room is configured to be archived.
- Switches:
- -msg (optional)
- the message
- -creation_user (optional)
- the alleged creation user of the persisted message. Won't be set automatically from the connection
- -creation_ip (optional)
- the alleged creation IP of the persisted message. Won't be set automatically from the connection
- Testcases:
- chat_room_tests
revoke_moderator (scripted, public)
<instance of xo::db::chat_room> revoke_moderator \ -party_id party_id
Revoke moderation rights on the chat room for specified party
- Switches:
- -party_id (required)
- Testcases:
- chat_room_tests
revoke_user (scripted, public)
<instance of xo::db::chat_room> revoke_user -party_id party_id
Revokes operative privileges to the specified party. In detail, the permission to read and write for the chat room.
- Switches:
- -party_id (required)
- Testcases:
- chat_room_tests
save_new (scripted, public)
<instance of xo::db::chat_room> save_new \ [ -creation_user creation_user ] args [ args... ]
Create a new chat room and make sure its creator is granted the necessary privileges
- Switches:
- -creation_user (optional)
- Parameters:
- args (required)
- Returns:
- new chat room id
- Testcases:
- chat_room_tests
transcript_messages (scripted, public)
<instance of xo::db::chat_room> transcript_messages
Formats the current content of a chat room as a list of messages formatted so they can be displayed or stored in the transcript.
- Returns:
- list of formatted messages
- Testcases:
- chat_room_tests
unban_user (scripted, public)
<instance of xo::db::chat_room> unban_user -party_id party_id
Lift ban on specified user from the chat room
- Switches:
- -party_id (required)
- Testcases:
- chat_room_tests
- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables
![[i]](/resources/acs-subsite/ZoomIn16.gif)