• discuss_channel_id Many2one → discuss.channel
  ondelete='cascade' required=True string='Discussion Channel' args: 'discuss.channel'
• mail_message_id Many2one → mail.message
  ondelete='cascade' required=True string='Related Mail Message' args: 'mail.message'
• script_step_id Many2one → chatbot.script.step
  ondelete='cascade' required=True string='Chatbot Step' args: 'chatbot.script.step'
• user_raw_answer Html
  string="User's raw answer"
• user_script_answer_id Many2one → chatbot.script.answer
  ondelete='set null' string="User's answer" args: 'chatbot.script.answer'

No public methods.

• active Boolean
  default=True
• first_step_warning Selection
  compute='_compute_first_step_warning' args: [('first_step_operator', 'First Step Operator'), ('first_step_invalid', 'First Step Invalid')]
• image_1920 Image
  readonly=False related='operator_partner_id.image_1920'
• livechat_channel_count Integer
  compute='_compute_livechat_channel_count' string='Livechat Channel Count'
• operator_partner_id Many2one → res.partner
  copy=False ondelete='restrict' required=True string='Bot Operator' args: 'res.partner'
• script_step_ids One2many → chatbot.script.step
  copy=True string='Script Steps' args: 'chatbot.script.step', 'chatbot_script_id'
• title Char
  default='Chatbot' required=True translate=True args: 'Title'

• action_view_livechat_channels(self)
• copy(self, default=None)
  Correctly copy the 'triggering_answer_ids' field from the original script_step_ids to the clone. This needs to be done in post-processing to make sure we get references to the newly created answers from the copy instead of references to the answers of the original. This implementation assumes that the order of created steps and answers will be kept between the original and the clone, using 'zip()' to match the records between the two.
• copy_data(self, default=None)
• create(self, vals_list)
  @api.model_create_multi
• write(self, vals)

• chatbot_script_id Many2one
  related='script_step_id.chatbot_script_id'
• name Char
  required=True string='Answer' translate=True
• redirect_link Char
  help='The visitor will be redirected to this link upon clicking the option (note that the script will end if the link is external to the livechat website).' args: 'Redirect Link'
• script_step_id Many2one → chatbot.script.step
  ondelete='cascade' required=True string='Script Step' args: 'chatbot.script.step'
• sequence Integer
  default=1 string='Sequence'

No public methods.

• answer_ids One2many → chatbot.script.answer
  copy=True string='Answers' args: 'chatbot.script.answer', 'script_step_id'
• chatbot_script_id Many2one → chatbot.script
  ondelete='cascade' required=True string='Chatbot' args: 'chatbot.script'
• is_forward_operator_child Boolean
  compute='_compute_is_forward_operator_child'
• message Text
  string='Message' translate=True
• sequence Integer
  string='Sequence'
• step_type Selection
  default='text' required=True args: [('text', 'Text'), ('question_selection', 'Question'), ('question_email', 'Email'), ('question_phone', 'Phone'), ('forward_operator', 'Forward to Operator'), ('free_input_single', 'Free Input'), ('free_input_multi', 'Free Input (Multi-Line)')]
• triggering_answer_ids Many2many → chatbot.script.answer
  compute='_compute_triggering_answer_ids' copy=False domain="[('script_step_id.sequence', '<', sequence)]" help='Show this step only if all of these answers have been selected.' readonly=False store=True string='Only If' args: 'chatbot.script.answer'

• create(self, vals_list)
  @api.model_create_multi
  Ensure we correctly assign sequences when creating steps. Indeed, sequences are very important within the script, and will break the whole flow if not correctly defined. This override will group created steps by chatbot_id and increment the sequence accordingly. It will also look for an existing step for that chatbot and resume from the highest sequence. This cannot be done in a default_value for the sequence field as we cannot search by runbot_id. It is also safer and more efficient to do it here (we can batch everything). It is still possible to manually pass the 'sequence' in the values, which will take priority.

• kpi_livechat_conversations Boolean
  args: 'Conversations handled'
• kpi_livechat_conversations_value Integer
  compute='_compute_kpi_livechat_conversations_value'
• kpi_livechat_rating Boolean
  args: '% of Happiness'
• kpi_livechat_rating_value Float
  compute='_compute_kpi_livechat_rating_value' digits=(16, 2)
• kpi_livechat_response Boolean
  args: 'Time to answer (sec)'
• kpi_livechat_response_value Float
  compute='_compute_kpi_livechat_response_value' digits=(16, 2)

No public methods.

• anonymous_name Char
  args: 'Anonymous Name'
• channel_type Selection
  ondelete={'livechat': 'cascade'} selection_add=[('livechat', 'Livechat Conversation')]
• chatbot_current_step_id Many2one → chatbot.script.step
  string='Chatbot Current Step' args: 'chatbot.script.step'
• chatbot_message_ids One2many → chatbot.message
  string='Chatbot Messages' args: 'chatbot.message', 'discuss_channel_id'
• country_id Many2one → res.country
  help='Country of the visitor of the channel' string='Country' args: 'res.country'
• duration Float
  compute='_compute_duration' help='Duration of the session in hours' args: 'Duration'
• livechat_active Boolean
  help='Livechat session is active until visitor leaves the conversation.' args: 'Is livechat ongoing?'
• livechat_channel_id Many2one → im_livechat.channel
  index='btree_not_null' args: 'im_livechat.channel', 'Channel'
• livechat_operator_id Many2one → res.partner
  index='btree_not_null' string='Operator' args: 'res.partner'

• execute_command_history(self, **kwargs)

No new fields.

No public methods.

• are_you_inside Boolean
  compute='_are_you_inside' readonly=True store=False string='Are you inside the matrix?'
• available_operator_ids Many2many → res.users
  compute='_compute_available_operator_ids' args: 'res.users'
• button_background_color Char
  default='#875A7B' help='Default background color of the Livechat button'
• button_text Char
  default=_default_button_text help='Default text displayed on the Livechat Support Button' translate=True args: 'Text of the Button'
• button_text_color Char
  default='#FFFFFF' help='Default text color of the Livechat button'
• channel_ids One2many → discuss.channel
  args: 'discuss.channel', 'livechat_channel_id', 'Sessions'
• chatbot_script_count Integer
  compute='_compute_chatbot_script_count' string='Number of Chatbot'
• default_message Char
  default=_default_default_message help="This is an automated 'welcome' message that your visitor will see when they initiate a new conversation." translate=True args: 'Welcome Message'
• header_background_color Char
  default='#875A7B' help='Default background color of the channel header once open'
• image_128 Image
  max_height=128 max_width=128 args: 'Image'
• input_placeholder Char
  help='Text that prompts the user to initiate the chat.' translate=True args: 'Chat Input Placeholder'
• name Char
  required=True args: 'Channel Name'
• nbr_channel Integer
  compute='_compute_nbr_channel' readonly=True store=False args: 'Number of conversation'
• rule_ids One2many → im_livechat.channel.rule
  args: 'im_livechat.channel.rule', 'channel_id', 'Rules'
• script_external Html
  compute='_compute_script_external' readonly=True sanitize=False store=False args: 'Script (external)'
• title_color Char
  default='#FFFFFF' help='Default title color of the channel once open'
• user_ids Many2many → res.users
  default=_default_user_ids string='Operators' args: 'res.users', 'im_livechat_channel_im_user', 'channel_id', 'user_id'
• web_page Char
  compute='_compute_web_page_link' help='URL to a static page where you client can discuss with the operator of the channel.' readonly=True store=False args: 'Web Page'

• action_join(self)
• action_quit(self)
• action_view_chatbot_scripts(self)
• action_view_rating(self)
  Action to display the rating relative to the channel, so all rating of the sessions of the current channel :returns : the ir.action 'action_view_rating' with the correct context
• get_livechat_info(self, username=None)

• action Selection
  default='display_button' help="* 'Show' displays the chat button on the pages.\n* 'Show with notification' is 'Show' in addition to a floating text just next to the button.\n* 'Open automatically' displays the button and automatically opens the conversation pane.\n* 'Hide' hides the chat button on the pages.\n" required=True string='Live Chat Button' args: [('display_button', 'Show'), ('display_button_and_text', 'Show with notification'), ('auto_popup', 'Open automatically'), ('hide_button', 'Hide')]
• auto_popup_timer Integer
  default=0 help="Delay (in seconds) to automatically open the conversation window. Note: the selected action must be 'Open automatically' otherwise this parameter will not be taken into account." args: 'Open automatically timer'
• channel_id Many2one → im_livechat.channel
  help='The channel of the rule' args: 'im_livechat.channel', 'Channel'
• chatbot_only_if_no_operator Boolean
  help='Enable the bot only if there is no operator available' string='Enabled only if no operator'
• chatbot_script_id Many2one → chatbot.script
  string='Chatbot' args: 'chatbot.script'
• country_ids Many2many → res.country
  help="The rule will only be applied for these countries. Example: if you select 'Belgium' and 'United States' and that you set the action to 'Hide', the chat button will be hidden on the specified URL from the visitors located in these 2 countries. This feature requires GeoIP installed on your server." args: 'res.country', 'im_livechat_channel_country_rel', 'channel_id', 'country_id', 'Country'
• regex_url Char
  help='Regular expression specifying the web pages this rule will be applied on.' args: 'URL Regex'
• sequence Integer
  default=10 help='Given the order to find a matching rule. If 2 rules are matching for the given url/country, the one with the lowest sequence will be chosen.' args: 'Matching order'

• match_rule(self, channel_id, url, country_id=False)
  determine if a rule of the given channel matches with the given url :param channel_id : the identifier of the channel_id :param url : the url to match with a rule :param country_id : the identifier of the country :returns the rule that matches the given condition. False otherwise. :rtype : im_livechat.channel.rule

• channel_id Many2one → discuss.channel
  readonly=True args: 'discuss.channel', 'Conversation'
• channel_name Char
  readonly=True args: 'Channel Name'
• country_id Many2one → res.country
  readonly=True args: 'res.country', 'Country of the visitor'
• day_number Char
  help='1 is Monday, 7 is Sunday' readonly=True args: 'Day Number'
• days_of_activity Integer
  aggregator='max' help='Number of days since the first session of the operator' readonly=True args: 'Days of activity'
• duration Float
  aggregator='avg' digits=(16, 2) help='Duration of the conversation (in seconds)' readonly=True args: 'Average duration'
• is_anonymous Integer
  readonly=True args: 'Is visitor anonymous'
• is_happy Integer
  readonly=True args: 'Visitor is Happy'
• is_unrated Integer
  readonly=True args: 'Session not rated'
• is_without_answer Integer
  aggregator='sum' help='A session is without answer if the operator did not answer. \n If the visitor is also the operator, the session will always be answered.' readonly=True args: 'Session(s) without answer'
• livechat_channel_id Many2one → im_livechat.channel
  readonly=True args: 'im_livechat.channel', 'Channel'
• nbr_message Integer
  aggregator='avg' help='Number of message in the conversation' readonly=True args: 'Average message'
• nbr_speaker Integer
  aggregator='avg' help='Number of different speakers' readonly=True args: '# of speakers'
• partner_id Many2one → res.partner
  readonly=True args: 'res.partner', 'Operator'
• rating Integer
  aggregator='avg' readonly=True args: 'Rating'
• rating_text Char
  readonly=True args: 'Satisfaction Rate'
• start_date Datetime
  readonly=True args: 'Start Date of session'
• start_date_hour Char
  readonly=True args: 'Hour of start Date of session'
• start_hour Char
  readonly=True args: 'Start Hour of session'
• technical_name Char
  readonly=True args: 'Code'
• time_to_answer Float
  aggregator='avg' digits=(16, 2) help='Average time in seconds to give the first answer to the visitor' readonly=True args: 'Time to answer (sec)'
• uuid Char
  readonly=True args: 'UUID'

• init(self)

• channel_id Many2one → discuss.channel
  readonly=True args: 'discuss.channel', 'Conversation'
• duration Float
  aggregator='avg' digits=(16, 2) help='Duration of the conversation (in seconds)' readonly=True args: 'Average duration'
• livechat_channel_id Many2one → im_livechat.channel
  readonly=True args: 'im_livechat.channel', 'Channel'
• nbr_channel Integer
  aggregator='sum' readonly=True args: '# of Sessions'
• partner_id Many2one → res.partner
  readonly=True args: 'res.partner', 'Operator'
• rating Float
  aggregator='avg' help='Average rating given by the visitor' readonly=True args: 'Average rating'
• start_date Datetime
  readonly=True args: 'Start Date of session'
• time_to_answer Float
  aggregator='avg' digits=(16, 2) help='Average time to give the first answer to the visitor' readonly=True args: 'Time to answer'

• init(self)

No new fields.

No public methods.

• parent_author_name Char
  compute='_compute_parent_author_name'
• parent_body Html
  compute='_compute_parent_body'

No public methods.

No new fields.

• action_open_rated_object(self)

• user_livechat_username Char
  compute='_compute_user_livechat_username'

No public methods.

• has_access_livechat Boolean
  compute='_compute_has_access_livechat' readonly=True store=False string='Has access to Livechat'
• livechat_lang_ids Many2many → res.lang
  compute='_compute_livechat_lang_ids' inverse='_inverse_livechat_lang_ids' store=False string='Livechat Languages' args: 'res.lang'
• livechat_username Char
  compute='_compute_livechat_username' inverse='_inverse_livechat_username' store=False string='Livechat Username'

• SELF_READABLE_FIELDS(self)
  @property
• SELF_WRITEABLE_FIELDS(self)
  @property

• livechat_lang_ids Many2many → res.lang
  comodel_name='res.lang' help='These languages, in addition to your main language, will be used to assign you to Live Chat sessions.' string='Livechat languages'
• livechat_username Char
  help='This username will be used as your name in the livechat channels.' args: 'Livechat Username'

No public methods.

• discuss_channel_id Many2one → discuss.channel
  ondelete='cascade' required=True string='Discussion Channel' args: 'discuss.channel'
• mail_message_id Many2one → mail.message
  ondelete='cascade' required=True string='Related Mail Message' args: 'mail.message'
• script_step_id Many2one → chatbot.script.step
  ondelete='cascade' required=True string='Chatbot Step' args: 'chatbot.script.step'
• user_raw_answer Html
  string="User's raw answer"
• user_script_answer_id Many2one → chatbot.script.answer
  ondelete='set null' string="User's answer" args: 'chatbot.script.answer'

No public methods.

• active Boolean
  default=True
• first_step_warning Selection
  compute='_compute_first_step_warning' args: [('first_step_operator', 'First Step Operator'), ('first_step_invalid', 'First Step Invalid')]
• image_1920 Image
  readonly=False related='operator_partner_id.image_1920'
• livechat_channel_count Integer
  compute='_compute_livechat_channel_count' string='Livechat Channel Count'
• operator_partner_id Many2one → res.partner
  copy=False ondelete='restrict' required=True string='Bot Operator' args: 'res.partner'
• script_step_ids One2many → chatbot.script.step
  copy=True string='Script Steps' args: 'chatbot.script.step', 'chatbot_script_id'
• title Char
  default='Chatbot' required=True translate=True args: 'Title'

• action_view_livechat_channels(self)
• copy(self, default=None)
  @api.returns('self', <expr>)
  Correctly copy the 'triggering_answer_ids' field from the original script_step_ids to the clone. This needs to be done in post-processing to make sure we get references to the newly created answers from the copy instead of references to the answers of the original. This implementation assumes that the order of created steps and answers will be kept between the original and the clone, using 'zip()' to match the records between the two.
• create(self, vals_list)
  @api.model_create_multi
• write(self, vals)

• chatbot_script_id Many2one
  related='script_step_id.chatbot_script_id'
• name Char
  required=True string='Answer' translate=True
• redirect_link Char
  help='The visitor will be redirected to this link upon clicking the option (note that the script will end if the link is external to the livechat website).' args: 'Redirect Link'
• script_step_id Many2one → chatbot.script.step
  ondelete='cascade' required=True string='Script Step' args: 'chatbot.script.step'
• sequence Integer
  default=1 string='Sequence'

No public methods.

• answer_ids One2many → chatbot.script.answer
  copy=True string='Answers' args: 'chatbot.script.answer', 'script_step_id'
• chatbot_script_id Many2one → chatbot.script
  ondelete='cascade' required=True string='Chatbot' args: 'chatbot.script'
• is_forward_operator_child Boolean
  compute='_compute_is_forward_operator_child'
• message Text
  string='Message' translate=True
• sequence Integer
  string='Sequence'
• step_type Selection
  default='text' required=True args: [('text', 'Text'), ('question_selection', 'Question'), ('question_email', 'Email'), ('question_phone', 'Phone'), ('forward_operator', 'Forward to Operator'), ('free_input_single', 'Free Input'), ('free_input_multi', 'Free Input (Multi-Line)')]
• triggering_answer_ids Many2many → chatbot.script.answer
  compute='_compute_triggering_answer_ids' copy=False domain="[('script_step_id.sequence', '<', sequence)]" help='Show this step only if all of these answers have been selected.' readonly=False store=True string='Only If' args: 'chatbot.script.answer'

• create(self, vals_list)
  @api.model_create_multi
  Ensure we correctly assign sequences when creating steps. Indeed, sequences are very important within the script, and will break the whole flow if not correctly defined. This override will group created steps by chatbot_id and increment the sequence accordingly. It will also look for an existing step for that chatbot and resume from the highest sequence. This cannot be done in a default_value for the sequence field as we cannot search by runbot_id. It is also safer and more efficient to do it here (we can batch everything). It is still possible to manually pass the 'sequence' in the values, which will take priority.

• kpi_livechat_conversations Boolean
  args: 'Conversations handled'
• kpi_livechat_conversations_value Integer
  compute='_compute_kpi_livechat_conversations_value'
• kpi_livechat_rating Boolean
  args: '% of Happiness'
• kpi_livechat_rating_value Float
  compute='_compute_kpi_livechat_rating_value' digits=(16, 2)
• kpi_livechat_response Boolean
  args: 'Time to answer (sec)'
• kpi_livechat_response_value Float
  compute='_compute_kpi_livechat_response_value' digits=(16, 2)

No public methods.

• anonymous_name Char
  args: 'Anonymous Name'
• channel_type Selection
  ondelete={'livechat': 'cascade'} selection_add=[('livechat', 'Livechat Conversation')]
• chatbot_current_step_id Many2one → chatbot.script.step
  string='Chatbot Current Step' args: 'chatbot.script.step'
• chatbot_message_ids One2many → chatbot.message
  string='Chatbot Messages' args: 'chatbot.message', 'discuss_channel_id'
• country_id Many2one → res.country
  help='Country of the visitor of the channel' string='Country' args: 'res.country'
• duration Float
  compute='_compute_duration' help='Duration of the session in hours' args: 'Duration'
• livechat_active Boolean
  help='Livechat session is active until visitor leaves the conversation.' args: 'Is livechat ongoing?'
• livechat_channel_id Many2one → im_livechat.channel
  index='btree_not_null' args: 'im_livechat.channel', 'Channel'
• livechat_operator_id Many2one → res.partner
  index='btree_not_null' string='Operator' args: 'res.partner'

• execute_command_history(self, **kwargs)

No new fields.

No public methods.

• are_you_inside Boolean
  compute='_are_you_inside' readonly=True store=False string='Are you inside the matrix?'
• available_operator_ids Many2many → res.users
  compute='_compute_available_operator_ids' args: 'res.users'
• button_background_color Char
  default='#875A7B' help='Default background color of the Livechat button'
• button_text Char
  default=_default_button_text help='Default text displayed on the Livechat Support Button' translate=True args: 'Text of the Button'
• button_text_color Char
  default='#FFFFFF' help='Default text color of the Livechat button'
• channel_ids One2many → discuss.channel
  args: 'discuss.channel', 'livechat_channel_id', 'Sessions'
• chatbot_script_count Integer
  compute='_compute_chatbot_script_count' string='Number of Chatbot'
• default_message Char
  default=_default_default_message help="This is an automated 'welcome' message that your visitor will see when they initiate a new conversation." translate=True args: 'Welcome Message'
• header_background_color Char
  default='#875A7B' help='Default background color of the channel header once open'
• image_128 Image
  max_height=128 max_width=128 args: 'Image'
• input_placeholder Char
  help='Text that prompts the user to initiate the chat.' translate=True args: 'Chat Input Placeholder'
• name Char
  required=True args: 'Channel Name'
• nbr_channel Integer
  compute='_compute_nbr_channel' readonly=True store=False args: 'Number of conversation'
• rule_ids One2many → im_livechat.channel.rule
  args: 'im_livechat.channel.rule', 'channel_id', 'Rules'
• script_external Html
  compute='_compute_script_external' readonly=True sanitize=False store=False args: 'Script (external)'
• title_color Char
  default='#FFFFFF' help='Default title color of the channel once open'
• user_ids Many2many → res.users
  default=_default_user_ids string='Operators' args: 'res.users', 'im_livechat_channel_im_user', 'channel_id', 'user_id'
• web_page Char
  compute='_compute_web_page_link' help='URL to a static page where you client can discuss with the operator of the channel.' readonly=True store=False args: 'Web Page'

• action_join(self)
• action_quit(self)
• action_view_chatbot_scripts(self)
• action_view_rating(self)
  Action to display the rating relative to the channel, so all rating of the sessions of the current channel :returns : the ir.action 'action_view_rating' with the correct context
• get_livechat_info(self, username=None)

• action Selection
  default='display_button' help="* 'Show' displays the chat button on the pages.\n* 'Show with notification' is 'Show' in addition to a floating text just next to the button.\n* 'Open automatically' displays the button and automatically opens the conversation pane.\n* 'Hide' hides the chat button on the pages.\n" required=True string='Live Chat Button' args: [('display_button', 'Show'), ('display_button_and_text', 'Show with notification'), ('auto_popup', 'Open automatically'), ('hide_button', 'Hide')]
• auto_popup_timer Integer
  default=0 help="Delay (in seconds) to automatically open the conversation window. Note: the selected action must be 'Open automatically' otherwise this parameter will not be taken into account." args: 'Open automatically timer'
• channel_id Many2one → im_livechat.channel
  help='The channel of the rule' args: 'im_livechat.channel', 'Channel'
• chatbot_only_if_no_operator Boolean
  help='Enable the bot only if there is no operator available' string='Enabled only if no operator'
• chatbot_script_id Many2one → chatbot.script
  string='Chatbot' args: 'chatbot.script'
• country_ids Many2many → res.country
  help="The rule will only be applied for these countries. Example: if you select 'Belgium' and 'United States' and that you set the action to 'Hide', the chat button will be hidden on the specified URL from the visitors located in these 2 countries. This feature requires GeoIP installed on your server." args: 'res.country', 'im_livechat_channel_country_rel', 'channel_id', 'country_id', 'Country'
• regex_url Char
  help='Regular expression specifying the web pages this rule will be applied on.' args: 'URL Regex'
• sequence Integer
  default=10 help='Given the order to find a matching rule. If 2 rules are matching for the given url/country, the one with the lowest sequence will be chosen.' args: 'Matching order'

• match_rule(self, channel_id, url, country_id=False)
  determine if a rule of the given channel matches with the given url :param channel_id : the identifier of the channel_id :param url : the url to match with a rule :param country_id : the identifier of the country :returns the rule that matches the given condition. False otherwise. :rtype : im_livechat.channel.rule

• channel_id Many2one → discuss.channel
  readonly=True args: 'discuss.channel', 'Conversation'
• channel_name Char
  readonly=True args: 'Channel Name'
• country_id Many2one → res.country
  readonly=True args: 'res.country', 'Country of the visitor'
• day_number Char
  help='1 is Monday, 7 is Sunday' readonly=True args: 'Day Number'
• days_of_activity Integer
  group_operator='max' help='Number of days since the first session of the operator' readonly=True args: 'Days of activity'
• duration Float
  digits=(16, 2) group_operator='avg' help='Duration of the conversation (in seconds)' readonly=True args: 'Average duration'
• is_anonymous Integer
  readonly=True args: 'Is visitor anonymous'
• is_happy Integer
  readonly=True args: 'Visitor is Happy'
• is_unrated Integer
  readonly=True args: 'Session not rated'
• is_without_answer Integer
  group_operator='sum' help='A session is without answer if the operator did not answer. \n If the visitor is also the operator, the session will always be answered.' readonly=True args: 'Session(s) without answer'
• livechat_channel_id Many2one → im_livechat.channel
  readonly=True args: 'im_livechat.channel', 'Channel'
• nbr_message Integer
  group_operator='avg' help='Number of message in the conversation' readonly=True args: 'Average message'
• nbr_speaker Integer
  group_operator='avg' help='Number of different speakers' readonly=True args: '# of speakers'
• partner_id Many2one → res.partner
  readonly=True args: 'res.partner', 'Operator'
• rating Integer
  group_operator='avg' readonly=True args: 'Rating'
• rating_text Char
  readonly=True args: 'Satisfaction Rate'
• start_date Datetime
  readonly=True args: 'Start Date of session'
• start_date_hour Char
  readonly=True args: 'Hour of start Date of session'
• start_hour Char
  readonly=True args: 'Start Hour of session'
• technical_name Char
  readonly=True args: 'Code'
• time_to_answer Float
  digits=(16, 2) group_operator='avg' help='Average time in seconds to give the first answer to the visitor' readonly=True args: 'Time to answer (sec)'
• uuid Char
  readonly=True args: 'UUID'

• init(self)

• channel_id Many2one → discuss.channel
  readonly=True args: 'discuss.channel', 'Conversation'
• duration Float
  digits=(16, 2) group_operator='avg' help='Duration of the conversation (in seconds)' readonly=True args: 'Average duration'
• livechat_channel_id Many2one → im_livechat.channel
  readonly=True args: 'im_livechat.channel', 'Channel'
• nbr_channel Integer
  group_operator='sum' readonly=True args: '# of Sessions'
• partner_id Many2one → res.partner
  readonly=True args: 'res.partner', 'Operator'
• rating Float
  group_operator='avg' help='Average rating given by the visitor' readonly=True args: 'Average rating'
• start_date Datetime
  readonly=True args: 'Start Date of session'
• time_to_answer Float
  digits=(16, 2) group_operator='avg' help='Average time to give the first answer to the visitor' readonly=True args: 'Time to answer'

• init(self)

No new fields.

No public methods.

• parent_author_name Char
  compute='_compute_parent_author_name'
• parent_body Html
  compute='_compute_parent_body'

No public methods.

No new fields.

• action_open_rated_object(self)

• user_livechat_username Char
  compute='_compute_user_livechat_username'

• search_for_channel_invite(self, search_term, channel_id=None, limit=30)
  @api.model

• has_access_livechat Boolean
  compute='_compute_has_access_livechat' readonly=True store=False string='Has access to Livechat'
• livechat_lang_ids Many2many → res.lang
  compute='_compute_livechat_lang_ids' inverse='_inverse_livechat_lang_ids' store=False string='Livechat Languages' args: 'res.lang'
• livechat_username Char
  compute='_compute_livechat_username' inverse='_inverse_livechat_username' store=False string='Livechat Username'

• SELF_READABLE_FIELDS(self)
  @property
• SELF_WRITEABLE_FIELDS(self)
  @property

• is_discuss_sidebar_category_livechat_open Boolean
  default=True args: 'Is category livechat open'
• livechat_lang_ids Many2many → res.lang
  comodel_name='res.lang' help='These languages, in addition to your main language, will be used to assign you to Live Chat sessions.' string='Livechat languages'
• livechat_username Char
  help='This username will be used as your name in the livechat channels.' args: 'Livechat Username'

No public methods.

• mail_channel_id Many2one → mail.channel
  ondelete='cascade' required=True string='Discussion Channel' args: 'mail.channel'
• mail_message_id Many2one → mail.message
  ondelete='cascade' required=True string='Related Mail Message' args: 'mail.message'
• script_step_id Many2one → chatbot.script.step
  ondelete='cascade' required=True string='Chatbot Step' args: 'chatbot.script.step'
• user_raw_answer Html
  string="User's raw answer"
• user_script_answer_id Many2one → chatbot.script.answer
  ondelete='set null' string="User's answer" args: 'chatbot.script.answer'

No public methods.

• active Boolean
  default=True
• first_step_warning Selection
  compute='_compute_first_step_warning' args: [('first_step_operator', 'First Step Operator'), ('first_step_invalid', 'First Step Invalid')]
• image_1920 Image
  readonly=False related='operator_partner_id.image_1920'
• livechat_channel_count Integer
  compute='_compute_livechat_channel_count' string='Livechat Channel Count'
• operator_partner_id Many2one → res.partner
  copy=False ondelete='restrict' required=True string='Bot Operator' args: 'res.partner'
• script_step_ids One2many → chatbot.script.step
  copy=True string='Script Steps' args: 'chatbot.script.step', 'chatbot_script_id'
• title Char
  default='Chatbot' required=True translate=True args: 'Title'

• action_view_livechat_channels(self)
• copy(self, default=None)
  @api.returns('self', <expr>)
  Correctly copy the 'triggering_answer_ids' field from the original script_step_ids to the clone. This needs to be done in post-processing to make sure we get references to the newly created answers from the copy instead of references to the answers of the original. This implementation assumes that the order of created steps and answers will be kept between the original and the clone, using 'zip()' to match the records between the two.
• create(self, vals_list)
  @api.model_create_multi
• write(self, vals)

• chatbot_script_id Many2one
  related='script_step_id.chatbot_script_id'
• name Char
  required=True string='Answer' translate=True
• redirect_link Char
  help='The visitor will be redirected to this link upon clicking the option (note that the script will end if the link is external to the livechat website).' args: 'Redirect Link'
• script_step_id Many2one → chatbot.script.step
  ondelete='cascade' required=True string='Script Step' args: 'chatbot.script.step'
• sequence Integer
  default=1 string='Sequence'

• name_get(self)

• answer_ids One2many → chatbot.script.answer
  copy=True string='Answers' args: 'chatbot.script.answer', 'script_step_id'
• chatbot_script_id Many2one → chatbot.script
  ondelete='cascade' required=True string='Chatbot' args: 'chatbot.script'
• is_forward_operator_child Boolean
  compute='_compute_is_forward_operator_child'
• message Text
  string='Message' translate=True
• sequence Integer
  string='Sequence'
• step_type Selection
  default='text' required=True args: [('text', 'Text'), ('question_selection', 'Question'), ('question_email', 'Email'), ('question_phone', 'Phone'), ('forward_operator', 'Forward to Operator'), ('free_input_single', 'Free Input'), ('free_input_multi', 'Free Input (Multi-Line)')]
• triggering_answer_ids Many2many → chatbot.script.answer
  compute='_compute_triggering_answer_ids' copy=False domain="[('script_step_id.sequence', '<', sequence)]" help='Show this step only if all of these answers have been selected.' readonly=False store=True string='Only If' args: 'chatbot.script.answer'

• create(self, vals_list)
  @api.model_create_multi
  Ensure we correctly assign sequences when creating steps. Indeed, sequences are very important within the script, and will break the whole flow if not correctly defined. This override will group created steps by chatbot_id and increment the sequence accordingly. It will also look for an existing step for that chatbot and resume from the highest sequence. This cannot be done in a default_value for the sequence field as we cannot search by runbot_id. It is also safer and more efficient to do it here (we can batch everything). It is still possible to manually pass the 'sequence' in the values, which will take priority.

• kpi_livechat_conversations Boolean
  args: 'Conversations handled'
• kpi_livechat_conversations_value Integer
  compute='_compute_kpi_livechat_conversations_value'
• kpi_livechat_rating Boolean
  args: '% of Happiness'
• kpi_livechat_rating_value Float
  compute='_compute_kpi_livechat_rating_value' digits=(16, 2)
• kpi_livechat_response Boolean
  args: 'Time to answer (sec)'
• kpi_livechat_response_value Float
  compute='_compute_kpi_livechat_response_value' digits=(16, 2)

No public methods.

• are_you_inside Boolean
  compute='_are_you_inside' readonly=True store=False string='Are you inside the matrix?'
• button_background_color Char
  default='#875A7B' help='Default background color of the Livechat button'
• button_text Char
  default=_default_button_text help='Default text displayed on the Livechat Support Button' args: 'Text of the Button'
• button_text_color Char
  default='#FFFFFF' help='Default text color of the Livechat button'
• channel_ids One2many → mail.channel
  args: 'mail.channel', 'livechat_channel_id', 'Sessions'
• chatbot_script_count Integer
  compute='_compute_chatbot_script_count' string='Number of Chatbot'
• default_message Char
  default=_default_default_message help="This is an automated 'welcome' message that your visitor will see when they initiate a new conversation." args: 'Welcome Message'
• header_background_color Char
  default='#875A7B' help='Default background color of the channel header once open'
• image_128 Image
  default=_default_image max_height=128 max_width=128 args: 'Image'
• input_placeholder Char
  help='Text that prompts the user to initiate the chat.' args: 'Chat Input Placeholder'
• name Char
  required=True args: 'Channel Name'
• nbr_channel Integer
  compute='_compute_nbr_channel' readonly=True store=False args: 'Number of conversation'
• rule_ids One2many → im_livechat.channel.rule
  args: 'im_livechat.channel.rule', 'channel_id', 'Rules'
• script_external Html
  compute='_compute_script_external' readonly=True sanitize=False store=False args: 'Script (external)'
• title_color Char
  default='#FFFFFF' help='Default title color of the channel once open'
• user_ids Many2many → res.users
  default=_default_user_ids string='Operators' args: 'res.users', 'im_livechat_channel_im_user', 'channel_id', 'user_id'
• web_page Char
  compute='_compute_web_page_link' help='URL to a static page where you client can discuss with the operator of the channel.' readonly=True store=False args: 'Web Page'

• action_join(self)
• action_quit(self)
• action_view_chatbot_scripts(self)
• action_view_rating(self)
  Action to display the rating relative to the channel, so all rating of the sessions of the current channel :returns : the ir.action 'action_view_rating' with the correct context
• get_livechat_info(self, username=None)

• action Selection
  default='display_button' help="* 'Show' displays the chat button on the pages.\n* 'Show with notification' is 'Show' in addition to a floating text just next to the button.\n* 'Open automatically' displays the button and automatically opens the conversation pane.\n* 'Hide' hides the chat button on the pages.\n" required=True string='Live Chat Button' args: [('display_button', 'Show'), ('display_button_and_text', 'Show with notification'), ('auto_popup', 'Open automatically'), ('hide_button', 'Hide')]
• auto_popup_timer Integer
  default=0 help="Delay (in seconds) to automatically open the conversation window. Note: the selected action must be 'Open automatically' otherwise this parameter will not be taken into account." args: 'Open automatically timer'
• channel_id Many2one → im_livechat.channel
  help='The channel of the rule' args: 'im_livechat.channel', 'Channel'
• chatbot_only_if_no_operator Boolean
  help='Enable the bot only if there is no operator available' string='Enabled only if no operator'
• chatbot_script_id Many2one → chatbot.script
  string='Chatbot' args: 'chatbot.script'
• country_ids Many2many → res.country
  help="The rule will only be applied for these countries. Example: if you select 'Belgium' and 'United States' and that you set the action to 'Hide', the chat button will be hidden on the specified URL from the visitors located in these 2 countries. This feature requires GeoIP installed on your server." args: 'res.country', 'im_livechat_channel_country_rel', 'channel_id', 'country_id', 'Country'
• regex_url Char
  help='Regular expression specifying the web pages this rule will be applied on.' args: 'URL Regex'
• sequence Integer
  default=10 help='Given the order to find a matching rule. If 2 rules are matching for the given url/country, the one with the lowest sequence will be chosen.' args: 'Matching order'

• match_rule(self, channel_id, url, country_id=False)
  determine if a rule of the given channel matches with the given url :param channel_id : the identifier of the channel_id :param url : the url to match with a rule :param country_id : the identifier of the country :returns the rule that matches the given condition. False otherwise. :rtype : im_livechat.channel.rule

• channel_id Many2one → mail.channel
  readonly=True args: 'mail.channel', 'Conversation'
• channel_name Char
  readonly=True args: 'Channel Name'
• country_id Many2one → res.country
  readonly=True args: 'res.country', 'Country of the visitor'
• day_number Char
  help='1 is Monday, 7 is Sunday' readonly=True args: 'Day Number'
• days_of_activity Integer
  group_operator='max' help='Number of days since the first session of the operator' readonly=True args: 'Days of activity'
• duration Float
  digits=(16, 2) group_operator='avg' help='Duration of the conversation (in seconds)' readonly=True args: 'Average duration'
• is_anonymous Integer
  readonly=True args: 'Is visitor anonymous'
• is_happy Integer
  readonly=True args: 'Visitor is Happy'
• is_unrated Integer
  readonly=True args: 'Session not rated'
• is_without_answer Integer
  group_operator='sum' help='A session is without answer if the operator did not answer. \n If the visitor is also the operator, the session will always be answered.' readonly=True args: 'Session(s) without answer'
• livechat_channel_id Many2one → im_livechat.channel
  readonly=True args: 'im_livechat.channel', 'Channel'
• nbr_message Integer
  group_operator='avg' help='Number of message in the conversation' readonly=True args: 'Average message'
• nbr_speaker Integer
  group_operator='avg' help='Number of different speakers' readonly=True args: '# of speakers'
• partner_id Many2one → res.partner
  readonly=True args: 'res.partner', 'Operator'
• rating Integer
  group_operator='avg' readonly=True args: 'Rating'
• rating_text Char
  readonly=True args: 'Satisfaction Rate'
• start_date Datetime
  readonly=True args: 'Start Date of session'
• start_date_hour Char
  readonly=True args: 'Hour of start Date of session'
• start_hour Char
  readonly=True args: 'Start Hour of session'
• technical_name Char
  readonly=True args: 'Code'
• time_to_answer Float
  digits=(16, 2) group_operator='avg' help='Average time in seconds to give the first answer to the visitor' readonly=True args: 'Time to answer (sec)'
• uuid Char
  readonly=True args: 'UUID'

• init(self)

• channel_id Many2one → mail.channel
  readonly=True args: 'mail.channel', 'Conversation'
• duration Float
  digits=(16, 2) group_operator='avg' help='Duration of the conversation (in seconds)' readonly=True args: 'Average duration'
• livechat_channel_id Many2one → im_livechat.channel
  readonly=True args: 'im_livechat.channel', 'Channel'
• nbr_channel Integer
  group_operator='sum' readonly=True args: '# of Sessions'
• partner_id Many2one → res.partner
  readonly=True args: 'res.partner', 'Operator'
• start_date Datetime
  readonly=True args: 'Start Date of session'
• time_to_answer Float
  digits=(16, 2) group_operator='avg' help='Average time to give the first answer to the visitor' readonly=True args: 'Time to answer'

• init(self)

• anonymous_name Char
  args: 'Anonymous Name'
• channel_type Selection
  ondelete={'livechat': 'cascade'} selection_add=[('livechat', 'Livechat Conversation')]
• chatbot_current_step_id Many2one → chatbot.script.step
  string='Chatbot Current Step' args: 'chatbot.script.step'
• chatbot_message_ids One2many → chatbot.message
  string='Chatbot Messages' args: 'chatbot.message', 'mail_channel_id'
• country_id Many2one → res.country
  help='Country of the visitor of the channel' string='Country' args: 'res.country'
• livechat_active Boolean
  help='Livechat session is active until visitor leaves the conversation.' args: 'Is livechat ongoing?'
• livechat_channel_id Many2one → im_livechat.channel
  index='btree_not_null' args: 'im_livechat.channel', 'Channel'
• livechat_operator_id Many2one → res.partner
  string='Operator' args: 'res.partner'

• channel_info(self)
  Extends the channel header by adding the livechat operator and the 'anonymous' profile :rtype : list(dict)
• execute_command_history(self, **kwargs)

No new fields.

No public methods.

No new fields.

No public methods.

No new fields.

• action_open_rated_object(self)

• user_livechat_username Char
  compute='_compute_user_livechat_username'

No public methods.

• livechat_username Char
  help='This username will be used as your name in the livechat channels.' args: 'Livechat Username'

• SELF_READABLE_FIELDS(self)
  @property
• SELF_WRITEABLE_FIELDS(self)
  @property

• is_discuss_sidebar_category_livechat_open Boolean
  default=True args: 'Is category livechat open'

No public methods.