larkgin

README

Lark Gin

Gin Middleware for go-lark.

Installation

go get -u github.com/go-lark/lark-gin

Usage

package main

import (
    "fmt"

    "github.com/gin-gonic/gin"
    "github.com/go-lark/lark"
    larkgin "github.com/go-lark/lark-gin"
)

func main() {
    r := gin.Default()

    middleware := larkgin.NewLarkMiddleware()
    r.Use(middleware.LarkMessageHandler())
    r.Use(middleware.LarkChallengeHandler())

    r.POST("/", func(c *gin.Context) {
        if msg, ok := middleware.GetMessage(c); ok { // => returns `*lark.EventMessage`
            fmt.Println(m.Event.Text)
        }
    })
}

Token Verification

middleware.WithTokenVerfication("asodjiaoijoi121iuhiaud")

Encryption

middleware.WithEncryption("1231asda")

URL Binding

Only bind specific URL for events:

middleware.BindURLPrefix("/abc")

About

Copyright (c) go-lark Developers, 2018-2021.

Documentation

Index

• Constants
• type LarkMiddleware
  • func NewLarkMiddleware() *LarkMiddleware
  • func (opt *LarkMiddleware) BindURLPrefix(prefix string) *LarkMiddleware
  • func (opt LarkMiddleware) GetMessage(c *gin.Context) (msg *lark.EventMessage, ok bool)
  • func (opt LarkMiddleware) LarkChallengeHandler() gin.HandlerFunc
  • func (opt LarkMiddleware) LarkMessageHandler() gin.HandlerFunc
  • func (opt *LarkMiddleware) SetMessageKey(key string) *LarkMiddleware
  • func (opt *LarkMiddleware) WithEncryption(key string) *LarkMiddleware
  • func (opt *LarkMiddleware) WithTokenVerification(token string) *LarkMiddleware

Constants

const DefaultLarkMessageKey = "go-lark-message"

DefaultLarkMessageKey still public for compatibility

Types

type LarkMiddleware

type LarkMiddleware struct {
	// contains filtered or unexported fields
}

LarkMiddleware .

func NewLarkMiddleware

func NewLarkMiddleware() *LarkMiddleware

NewLarkMiddleware .

func (*LarkMiddleware) BindURLPrefix

func (opt *LarkMiddleware) BindURLPrefix(prefix string) *LarkMiddleware

BindURLPrefix .

func (LarkMiddleware) GetMessage

func (opt LarkMiddleware) GetMessage(c *gin.Context) (msg *lark.EventMessage, ok bool)

GetMessage from gin context

func (LarkMiddleware) LarkChallengeHandler

func (opt LarkMiddleware) LarkChallengeHandler() gin.HandlerFunc

LarkChallengeHandler Lark challenge handler

func (LarkMiddleware) LarkMessageHandler

func (opt LarkMiddleware) LarkMessageHandler() gin.HandlerFunc

LarkMessageHandler Lark message handler

func (*LarkMiddleware) SetMessageKey

func (opt *LarkMiddleware) SetMessageKey(key string) *LarkMiddleware

SetMessageKey .

func (*LarkMiddleware) WithEncryption

func (opt *LarkMiddleware) WithEncryption(key string) *LarkMiddleware

WithEncryption .

func (*LarkMiddleware) WithTokenVerification

func (opt *LarkMiddleware) WithTokenVerification(token string) *LarkMiddleware

WithTokenVerification .