iT邦幫忙

2023 iThome 鐵人賽

DAY 11
0
Odoo

Odoo 16 OCA 模組介紹 - web系列 第 11

【Day 11】Odoo OCA 模組 - web :web_notify

  • 分享至 

  • xImage
  •  

🍄本日魔法

 web_notify

   適用版本:16.0、15.0、14.0、13.0
 https://ithelp.ithome.com.tw/upload/images/20230923/20161873chgLOPA3uj.png

🍄模組功能

此模組允許開發人員透過 API ,將通知訊息以彈出視窗的形式向使用者發送。
支援五種通知:

  1. 成功:訊息顯示在成功主題顏色的彈出視窗中。
  2. 危險:訊息顯示在危險主題顏色的彈出視窗中。
  3. 警告:訊息顯示在警告主題顏色的彈出視窗中。
  4. 資訊:訊息顯示在資訊主題顏色的彈出視窗中。
  5. 預設:訊息顯示在預設主題顏色的彈出視窗中。
    此模組基於 Instant Messaging Bus,為了正確運作,必須先安裝 bus 模組且在 gevent 模式下啟動。
    https://ithelp.ithome.com.tw/upload/images/20230926/20161873BssCoeeqLS.png

🍄使用情境

在系統開發過程中,當某些操作或動作被錯誤執行時,開發人員可能會希望給使用者一些提示,
在開發過程中可能會需要測試這些提示訊息是否有正常運作,那就可以安裝 web_notify 模組,來協助測試。
安裝模組之後,
開發人員可以在「需要跳出通知訊息」的模組、程式碼,
寫入 web_notify 模組的 API :

  1. 成功:self.env.user.notify_success(message='Default message')
  2. 危險:self.env.user.notify_danger(message='Default message')
  3. 警告:self.env.user.notify_warning(message='Default message')
  4. 資訊:self.env.user.notify_info(message='Default message')
  5. 預設:self.env.user.notify_default(message='Default message')

每個方法都有4個參數:

  1. message: 要發送的通知訊息。
  2. title: 通知的標題。
  3. sticky: 決定通知是否應該保持顯示,直到使用者手動關閉它。
  4. target: 通知的目標接收者。

如果客戶對於彈出視窗有客製化需求(例如視窗停留時間等),
或是開發人員需要新增功能需求或有調整 UI/UX 的需求,
總之,任何需要調整 web_notify 模組 API 的狀況,
都可以在模組包的 res_users.py 檔案中進行編輯。
修改完畢後,如果要測試web_notify模組的API是否正常運作,
可以在設定 > 使用者及公司 > 使用者 > Test web notify進行測試。
https://ithelp.ithome.com.tw/upload/images/20230923/20161873phM0nwGCx2.jpghttps://ithelp.ithome.com.tw/upload/images/20230923/2016187328N4oCJEHc.jpg
這邊會有5個按鈕,分別可以測試不同的通知訊息:
https://ithelp.ithome.com.tw/upload/images/20230923/201618737KekFgcWWb.png

🍄心得感想

我想這個模組對於「正在開發新模組的開發人員」來說是個福音。
訊息提醒通知是一個很常會被需要的功能,開發一個全新的模組,在規劃新模組的工作流程時,需要花費許多心思,如果有 web_notify 的輔助就能減少重新開發「通知訊息」功能的時間,將時間精力專注在其他創新的功能上。
才寫到第11天,就感覺自己快要變成無情的研究測試機器,缺乏感受變成一個沒有心得感想的人XD
值得慶幸的是已經完成1/3鐵人之路了ε٩(๑> ₃ <)۶з


p.s. Test web notify 頁籤,預設不用開啟開發者模式也能檢視及使用,所以開發人員若是不想要讓一般使用者看到這個頁籤,記得要把它藏起來喔。(不過一般權限的使用者,可能也不能拜訪"設定"就是了)


上一篇
【Day 10】Odoo OCA 模組 - web :web_listview_range_select
下一篇
【Day 12】Odoo OCA 模組 - web :web_refresher
系列文
Odoo 16 OCA 模組介紹 - web30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言