gitee.com/larksuite/oapi-sdk-go/v3@v3.0.3/event/dispatcher/ext_event_dispatch.go (about) 1 /* 2 * MIT License 3 * 4 * Copyright (c) 2022 Lark Technologies Pte. Ltd. 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 7 * 8 * The above copyright notice and this permission notice, shall be included in all copies or substantial portions of the Software. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 11 */ 12 13 // Package dispatcher code generated by oapi sdk gen 14 package dispatcher 15 16 import ( 17 "context" 18 19 larkevent "gitee.com/larksuite/oapi-sdk-go/v3/event" 20 larkapplication "gitee.com/larksuite/oapi-sdk-go/v3/service/application/v6" 21 larkapproval "gitee.com/larksuite/oapi-sdk-go/v3/service/approval/v4" 22 larkcontact "gitee.com/larksuite/oapi-sdk-go/v3/service/contact/v3" 23 larkim "gitee.com/larksuite/oapi-sdk-go/v3/service/im/v1" 24 larkmeeting_room "gitee.com/larksuite/oapi-sdk-go/v3/service/meeting_room/v1" 25 ) 26 27 // v1消息协议:用户购买应用商店付费应用成功后发送给应用ISV的通知事件。 28 // 29 // 事件描述文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/event/public-app-purchase 30 func (dispatcher *EventDispatcher) OnP1OrderPaidV6(handler func(ctx context.Context, event *larkapplication.P1OrderPaidV6) error) *EventDispatcher { 31 _, existed := dispatcher.eventType2EventHandler["order_paid"] 32 if existed { 33 panic("event: multiple handler registrations for " + "order_paid") 34 } 35 dispatcher.eventType2EventHandler["order_paid"] = larkapplication.NewP1OrderPaidV6Handler(handler) 36 return dispatcher 37 } 38 39 // v1消息协议:企业解散后会推送此事件。商店应用开发者可在收到此事件后进行相应的账户注销、数据清理等处理。自建应用无此事件。 40 // 41 // 事件描述文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/event/app-uninstalled 42 func (dispatcher *EventDispatcher) OnP1AppUninstalledV6(handler func(ctx context.Context, event *larkapplication.P1AppUninstalledV6) error) *EventDispatcher { 43 _, existed := dispatcher.eventType2EventHandler["app_uninstalled"] 44 if existed { 45 panic("event: multiple handler registrations for " + "app_uninstalled") 46 } 47 dispatcher.eventType2EventHandler["app_uninstalled"] = larkapplication.NewP1AppUninstalledV6Handler(handler) 48 return dispatcher 49 } 50 51 // v1消息协议:当企业管理员在管理员后台启用、停用应用,或应用被平台停用时,开放平台推送 app_status_change 事件到请求网址。 52 // 53 // 事件描述文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/event/app-enabled-or-disabled 54 func (dispatcher *EventDispatcher) OnP1AppStatusChangedV6(handler func(ctx context.Context, event *larkapplication.P1AppStatusChangedV6) error) *EventDispatcher { 55 _, existed := dispatcher.eventType2EventHandler["app_status_change"] 56 if existed { 57 panic("event: multiple handler registrations for " + "app_status_change") 58 } 59 dispatcher.eventType2EventHandler["app_status_change"] = larkapplication.NewP1AppStatusChangedV6Handler(handler) 60 return dispatcher 61 } 62 63 // v1消息协议:用户阅读机器人发送的消息后触发此事件。 64 // 65 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/ugzMugzMugzM/event/message-read 66 func (dispatcher *EventDispatcher) OnP1MessageReadV1(handler func(ctx context.Context, event *larkim.P1MessageReadV1) error) *EventDispatcher { 67 _, existed := dispatcher.eventType2EventHandler["message_read"] 68 if existed { 69 panic("event: multiple handler registrations for " + "message_read") 70 } 71 dispatcher.eventType2EventHandler["message_read"] = larkim.NewP1MessageReadV1Handler(handler) 72 return dispatcher 73 } 74 75 // v1消息协议:当用户发送消息给机器人或在群聊中@机器人时触发此事件。 76 // 77 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/ugzMugzMugzM/event/receive-message 78 func (dispatcher *EventDispatcher) OnP1MessageReceiveV1(handler func(ctx context.Context, event *larkim.P1MessageReceiveV1) error) *EventDispatcher { 79 _, existed := dispatcher.eventType2EventHandler["message"] 80 if existed { 81 panic("event: multiple handler registrations for " + "message") 82 } 83 dispatcher.eventType2EventHandler["message"] = larkim.NewP1MessageReceiveV1Handler(handler) 84 return dispatcher 85 } 86 87 // v1消息协议:当员工的激活、暂停账号/恢复账号、操作离职时会触发此事件。此事件不依赖于任何权限。 88 // 89 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM//event/user-status-changed 90 func (dispatcher *EventDispatcher) OnP1UserStatusChangedV3(handler func(ctx context.Context, event *larkcontact.P1UserStatusChangedV3) error) *EventDispatcher { 91 _, existed := dispatcher.eventType2EventHandler["user_status_change"] 92 if existed { 93 panic("event: multiple handler registrations for " + "user_status_change") 94 } 95 dispatcher.eventType2EventHandler["user_status_change"] = larkcontact.NewP1UserStatusChangedV3Handler(handler) 96 return dispatcher 97 } 98 99 // v1消息协议:当员工加入企业(user_add)、离职(user_leave)、个人信息发生变化(user_update)时,推送此事件。 100 // 101 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM//event/employee-change 102 func (dispatcher *EventDispatcher) OnP1UserChangedV3(handler func(ctx context.Context, event *larkcontact.P1UserChangedV3) error) *EventDispatcher { 103 _, existed := dispatcher.eventType2EventHandler["user_add"] 104 if existed { 105 panic("event: multiple handler registrations for " + "user_add") 106 } 107 dispatcher.eventType2EventHandler["user_add"] = larkcontact.NewP1UserChangedV3Handler(handler) 108 109 _, existed = dispatcher.eventType2EventHandler["user_leave"] 110 if existed { 111 panic("event: multiple handler registrations for " + "user_add") 112 } 113 dispatcher.eventType2EventHandler["user_leave"] = larkcontact.NewP1UserChangedV3Handler(handler) 114 115 _, existed = dispatcher.eventType2EventHandler["user_update"] 116 if existed { 117 panic("event: multiple handler registrations for " + "user_update") 118 } 119 dispatcher.eventType2EventHandler["user_update"] = larkcontact.NewP1UserChangedV3Handler(handler) 120 return dispatcher 121 } 122 123 // v1消息协议:当新建部门(dept_add)、删除部门(dept_delete)、修改部门(dept_update)时,推送此事件。 124 // 125 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM//event/department-update 126 func (dispatcher *EventDispatcher) OnP1DepartmentChangedV3(handler func(ctx context.Context, event *larkcontact.P1DepartmentChangedV3) error) *EventDispatcher { 127 _, existed := dispatcher.eventType2EventHandler["dept_add"] 128 if existed { 129 panic("event: multiple handler registrations for " + "dept_add") 130 } 131 dispatcher.eventType2EventHandler["dept_add"] = larkcontact.NewP1DepartmentChangedV3Handler(handler) 132 133 _, existed = dispatcher.eventType2EventHandler["dept_delete"] 134 if existed { 135 panic("event: multiple handler registrations for " + "dept_delete") 136 } 137 dispatcher.eventType2EventHandler["dept_delete"] = larkcontact.NewP1DepartmentChangedV3Handler(handler) 138 139 _, existed = dispatcher.eventType2EventHandler["dept_update"] 140 if existed { 141 panic("event: multiple handler registrations for " + "dept_update") 142 } 143 dispatcher.eventType2EventHandler["dept_update"] = larkcontact.NewP1DepartmentChangedV3Handler(handler) 144 return dispatcher 145 } 146 147 // v1消息协议:当应用申请了 以应用身份访问通讯录 权限后,管理员可以配置应用的通讯录授权范围,当此范围变化时,就会触发授权范围变化事件。 148 // 149 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM//event/scope-change 150 func (dispatcher *EventDispatcher) OnP1ContactScopeChangedV3(handler func(ctx context.Context, event *larkcontact.P1ContactScopeChangedV3) error) *EventDispatcher { 151 _, existed := dispatcher.eventType2EventHandler["contact_scope_change"] 152 if existed { 153 panic("event: multiple handler registrations for " + "contact_scope_change") 154 } 155 dispatcher.eventType2EventHandler["contact_scope_change"] = larkcontact.NewP1ContactScopeChangedV3Handler(handler) 156 return dispatcher 157 } 158 159 // v1消息协议:机器人被邀请加入群聊时触发此事件。 160 // 161 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/ugzMugzMugzM/event/bot-added-to-group 162 func (dispatcher *EventDispatcher) OnP1AddBotV1(handler func(ctx context.Context, event *larkim.P1AddBotV1) error) *EventDispatcher { 163 _, existed := dispatcher.eventType2EventHandler["add_bot"] 164 if existed { 165 panic("event: multiple handler registrations for " + "add_bot") 166 } 167 dispatcher.eventType2EventHandler["add_bot"] = larkim.NewP1AddBotV1Handler(handler) 168 return dispatcher 169 } 170 171 // v1消息协议:机器人被从群聊中移除时触发此事件。 172 // 173 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/ugzMugzMugzM/event/bot-removed-from-group 174 func (dispatcher *EventDispatcher) OnP1RemoveAddBotV1(handler func(ctx context.Context, event *larkim.P1RemoveBotV1) error) *EventDispatcher { 175 _, existed := dispatcher.eventType2EventHandler["remove_bot"] 176 if existed { 177 panic("event: multiple handler registrations for " + "remove_bot") 178 } 179 dispatcher.eventType2EventHandler["remove_bot"] = larkim.NewP1RemoveBotV1Handler(handler) 180 return dispatcher 181 } 182 183 // v1消息协议:用户进群、出群后触发此事件 184 // 185 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uQDOwUjL0gDM14CN4ATN/event/user-joins-or-leave-group 186 func (dispatcher *EventDispatcher) OnP1UserInOutChatV1(handler func(ctx context.Context, event *larkim.P1UserInOutChatV1) error) *EventDispatcher { 187 _, existed := dispatcher.eventType2EventHandler["add_user_to_chat"] 188 if existed { 189 panic("event: multiple handler registrations for " + "add_user_to_chat") 190 } 191 dispatcher.eventType2EventHandler["add_user_to_chat"] = larkim.NewP1UserInOutChatV1Handler(handler) 192 193 _, existed = dispatcher.eventType2EventHandler["remove_user_from_chat"] 194 if existed { 195 panic("event: multiple handler registrations for " + "remove_user_from_chat") 196 } 197 dispatcher.eventType2EventHandler["remove_user_from_chat"] = larkim.NewP1UserInOutChatV1Handler(handler) 198 199 _, existed = dispatcher.eventType2EventHandler["revoke_add_user_from_chat"] 200 if existed { 201 panic("event: multiple handler registrations for " + "revoke_add_user_from_chat") 202 } 203 dispatcher.eventType2EventHandler["revoke_add_user_from_chat"] = larkim.NewP1UserInOutChatV1Handler(handler) 204 return dispatcher 205 } 206 207 // v1消息协议:群聊被解散后触发此事件。 208 // 209 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uQDOwUjL0gDM14CN4ATN/event/group-closed 210 func (dispatcher *EventDispatcher) OnP1ChatDisbandV1(handler func(ctx context.Context, event *larkim.P1ChatDisbandV1) error) *EventDispatcher { 211 _, existed := dispatcher.eventType2EventHandler["chat_disband"] 212 if existed { 213 panic("event: multiple handler registrations for " + "chat_disband") 214 } 215 dispatcher.eventType2EventHandler["chat_disband"] = larkim.NewP1DisbandChatV1Handler(handler) 216 return dispatcher 217 } 218 219 // v1消息协议:群配置修改后触发此事件。 220 // 221 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uQDOwUjL0gDM14CN4ATN/event/group-configuration-changes 222 func (dispatcher *EventDispatcher) OnP1GroupSettingUpdatedV1(handler func(ctx context.Context, event *larkim.P1GroupSettingUpdatedV1) error) *EventDispatcher { 223 _, existed := dispatcher.eventType2EventHandler["group_setting_update"] 224 if existed { 225 panic("event: multiple handler registrations for " + "group_setting_update") 226 } 227 dispatcher.eventType2EventHandler["group_setting_update"] = larkim.NewP1GroupSettingUpdatedV1Handler(handler) 228 return dispatcher 229 } 230 231 // v1消息协议:当租户第一次安装并启用此应用时触发此事件,启用应用包含以下场景: 232 // 当租户管理员后台首次开通应用 233 // 租户内的普通成员首次安装此应用 234 // 235 // 事件描述文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/event/app-first-enabled 236 func (dispatcher *EventDispatcher) OnP1AppOpenV6(handler func(ctx context.Context, event *larkapplication.P1AppOpenV6) error) *EventDispatcher { 237 _, existed := dispatcher.eventType2EventHandler["app_open"] 238 if existed { 239 panic("event: multiple handler registrations for " + "app_open") 240 } 241 dispatcher.eventType2EventHandler["app_open"] = larkapplication.NewP1AppOpenV6Handler(handler) 242 return dispatcher 243 } 244 245 // v1消息协议:首次会话是用户了解应用的重要机会,你可以发送操作说明、配置地址来指导用户开始使用你的应用。 246 // 247 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/bot-events 248 func (dispatcher *EventDispatcher) OnP1P2PChatCreatedV1(handler func(ctx context.Context, event *larkim.P1P2PChatCreatedV1) error) *EventDispatcher { 249 _, existed := dispatcher.eventType2EventHandler["p2p_chat_create"] 250 if existed { 251 panic("event: multiple handler registrations for " + "p2p_chat_create") 252 } 253 dispatcher.eventType2EventHandler["p2p_chat_create"] = larkim.NewP1P2PChatCreatedV1Handler(handler) 254 return dispatcher 255 } 256 257 // v1消息协议:当添加了第三方会议室的日程发生变动时(创建/更新/删除)触发此事件。 258 // 259 // 事件描述文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/meeting_room-v1/event/third-room-event-changes 260 func (dispatcher *EventDispatcher) OnP1ThirdPartyMeetingRoomChangedV1(handler func(ctx context.Context, event *larkmeeting_room.P1ThirdPartyMeetingRoomChangedV1) error) *EventDispatcher { 261 _, existed := dispatcher.eventType2EventHandler["third_party_meeting_room_event_created"] 262 if existed { 263 panic("event: multiple handler registrations for " + "third_party_meeting_room_event_created") 264 } 265 dispatcher.eventType2EventHandler["third_party_meeting_room_event_created"] = larkmeeting_room.NewP1ThirdPartyMeetingRoomChangedV1Handler(handler) 266 267 _, existed = dispatcher.eventType2EventHandler["third_party_meeting_room_event_updated"] 268 if existed { 269 panic("event: multiple handler registrations for " + "third_party_meeting_room_event_updated") 270 } 271 dispatcher.eventType2EventHandler["third_party_meeting_room_event_updated"] = larkmeeting_room.NewP1ThirdPartyMeetingRoomChangedV1Handler(handler) 272 273 _, existed = dispatcher.eventType2EventHandler["third_party_meeting_room_event_deleted"] 274 if existed { 275 panic("event: multiple handler registrations for " + "third_party_meeting_room_event_deleted") 276 } 277 dispatcher.eventType2EventHandler["third_party_meeting_room_event_deleted"] = larkmeeting_room.NewP1ThirdPartyMeetingRoomChangedV1Handler(handler) 278 return dispatcher 279 } 280 281 // v1消息协议:审批」应用的表单里如果包含 请假控件组,则在此表单审批通过后触发此事件。 282 // 283 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/leave 284 func (dispatcher *EventDispatcher) OnP1LeaveApprovalV4(handler func(ctx context.Context, event *larkapproval.P1LeaveApprovalV4) error) *EventDispatcher { 285 _, existed := dispatcher.eventType2EventHandler["leave_approvalV2"] 286 if existed { 287 panic("event: multiple handler registrations for " + "leave_approvalV2") 288 } 289 dispatcher.eventType2EventHandler["leave_approvalV2"] = larkapproval.NewP1LeaveApprovalV4Handler(handler) 290 return dispatcher 291 } 292 293 // v1消息协议:「审批」应用的表单里如果包含 加班控件组,则在此表单审批通过后触发此事件。 294 // 295 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/overtime 296 func (dispatcher *EventDispatcher) OnP1WorkApprovalV4(handler func(ctx context.Context, event *larkapproval.P1WorkApprovalV4) error) *EventDispatcher { 297 _, existed := dispatcher.eventType2EventHandler["work_approval"] 298 if existed { 299 panic("event: multiple handler registrations for " + "work_approval") 300 } 301 dispatcher.eventType2EventHandler["work_approval"] = larkapproval.NewP1WorkApprovalV4Handler(handler) 302 return dispatcher 303 } 304 305 // v1消息协议:换班申请审批通过后触发此事件。 你可以在「打卡」应用里提交换班申请。 306 // 307 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/shift-change 308 func (dispatcher *EventDispatcher) OnP1ShiftApprovalV4(handler func(ctx context.Context, event *larkapproval.P1ShiftApprovalV4) error) *EventDispatcher { 309 _, existed := dispatcher.eventType2EventHandler["shift_approval"] 310 if existed { 311 panic("event: multiple handler registrations for " + "shift_approval") 312 } 313 dispatcher.eventType2EventHandler["shift_approval"] = larkapproval.NewP1ShiftApprovalV4Handler(handler) 314 return dispatcher 315 } 316 317 // v1消息协议:补卡申请审批通过后触发此事件。 你可以在「打卡」应用里提交补卡申请。 318 // 319 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/attendance-record-correction 320 func (dispatcher *EventDispatcher) OnP1RemedyApprovalV4(handler func(ctx context.Context, event *larkapproval.P1RemedyApprovalV4) error) *EventDispatcher { 321 _, existed := dispatcher.eventType2EventHandler["remedy_approval"] 322 if existed { 323 panic("event: multiple handler registrations for " + "remedy_approval") 324 } 325 dispatcher.eventType2EventHandler["remedy_approval"] = larkapproval.NewP1RemedyApprovalV4Handler(handler) 326 return dispatcher 327 } 328 329 // v1消息协议:「审批」应用的表单里如果包含 出差控件组,则在此表单审批通过后触发此事件。 330 // 331 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/business-trip 332 func (dispatcher *EventDispatcher) OnP1TripApprovalV4(handler func(ctx context.Context, event *larkapproval.P1TripApprovalV4) error) *EventDispatcher { 333 _, existed := dispatcher.eventType2EventHandler["trip_approval"] 334 if existed { 335 panic("event: multiple handler registrations for " + "trip_approval") 336 } 337 dispatcher.eventType2EventHandler["trip_approval"] = larkapproval.NewP1TripApprovalV4Handler(handler) 338 return dispatcher 339 } 340 341 // v1消息协议:「审批」应用的表单里如果包含 外出控件组,则在此表单审批通过后触发此事件。 342 // 343 // 事件描述文档:https://open.feishu.cn/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/out-of-office 344 func (dispatcher *EventDispatcher) OnP1OutApprovalV4(handler func(ctx context.Context, event *larkapproval.P1OutApprovalV4) error) *EventDispatcher { 345 _, existed := dispatcher.eventType2EventHandler["out_approval"] 346 if existed { 347 panic("event: multiple handler registrations for " + "out_approval") 348 } 349 dispatcher.eventType2EventHandler["out_approval"] = larkapproval.NewP1OutApprovalV4Handler(handler) 350 return dispatcher 351 } 352 353 // 订阅事件扩展:开发者可自己传递事件类型,并传递对应事件类型的处理器 354 func (dispatcher *EventDispatcher) OnCustomizedEvent(eventType string, handler func(ctx context.Context, event *larkevent.EventReq) error) *EventDispatcher { 355 _, existed := dispatcher.eventType2EventHandler[eventType] 356 if existed { 357 panic("event: multiple handler registrations for " + eventType) 358 } 359 dispatcher.eventType2EventHandler[eventType] = &defaultHandler{handler: handler} 360 return dispatcher 361 } 362 363 // 当 ISV 需要自己管理 app_ticket 和 token 时,需要注册该处理器,以获取app_ticket。这时 SDK 内将不能帮开发者自动获取和缓存token。 364 // 365 // 事件描述文档:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/event/app_ticket-events 366 func (dispatcher *EventDispatcher) OnAppTicketEvent(handler func(ctx context.Context, event *AppTicketEvent) error) *EventDispatcher { 367 dispatcher.eventType2EventHandler["app_ticket"] = &CustomAppTicketEventHandler{handler: handler} 368 return dispatcher 369 }