spamcheck

Documentation

Index

• type MetaData
• type Request
  • func (r *Request) String() string
• type Response
  • func (r *Response) String() string

Types

type MetaData

type MetaData struct {
	Images   int  `json:"images"`    // number of images in the message
	Links    int  `json:"links"`     // number of links in the message
	HasVideo bool `json:"has_video"` // true if the message has a video or video note
}

MetaData is a meta-info about the message, provided by the client.

type Request

type Request struct {
	Msg      string   `json:"msg"`       // message to check
	UserID   string   `json:"user_id"`   // user id
	UserName string   `json:"user_name"` // user name
	Meta     MetaData `json:"meta"`      // meta-info, provided by the client
}

Request is a request to check a message for spam.

func (*Request) String

func (r *Request) String() string

type Response

type Response struct {
	Name    string `json:"name"`    // name of the check
	Spam    bool   `json:"spam"`    // true if spam
	Details string `json:"details"` // details of the check
	Error   error  `json:"-"`       // error message, if any. Do not serialize it
}

Response is a result of spam check.

func (*Response) String

func (r *Response) String() string