mirror of
https://github.com/cwinfo/matterbridge.git
synced 2024-09-20 17:12:31 +00:00
8764be7461
* Add vk bridge * Vk bridge attachments * Vk bridge forwarded messages * Vk bridge sample config and code cleanup * Vk bridge add vendor * Vk bridge message edit * Vk bridge: fix fetching names of other bots * Vk bridge: code cleanup * Vk bridge: fix shadows declaration * Vk bridge: remove UseFileURL
122 lines
4.1 KiB
Markdown
122 lines
4.1 KiB
Markdown
# VK SDK for Golang
|
|
|
|
[](https://travis-ci.com/SevereCloud/vksdk)
|
|
[](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2?tab=subdirectories)
|
|
[](https://vk.com/dev/)
|
|
[](https://codecov.io/gh/SevereCloud/vksdk)
|
|
[](https://vk.me/join/AJQ1d6Or8Q00Y_CSOESfbqGt)
|
|
[](https://github.com/SevereCloud/vksdk/releases)
|
|
[](https://github.com/SevereCloud/vksdk/blob/master/LICENSE)
|
|
|
|
**VK SDK for Golang** ready implementation of the main VK API functions for Go.
|
|
|
|
[Russian documentation](https://github.com/SevereCloud/vksdk/wiki)
|
|
|
|
## Features
|
|
|
|
Version API 5.126.
|
|
|
|
- [API](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2/api)
|
|
- 400+ methods
|
|
- Ability to change the request handler
|
|
- Ability to modify HTTP client
|
|
- Request Limiter
|
|
- Token pool
|
|
- [Callback API](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2/callback)
|
|
- Tracking tool for users activity in your VK communities
|
|
- Supports all events
|
|
- Auto setting callback
|
|
- [Bots Long Poll API](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2/longpoll-bot)
|
|
- Allows you to work with community events in real time
|
|
- Supports all events
|
|
- Ability to modify HTTP client
|
|
- [User Long Poll API](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2/longpoll-user)
|
|
- Allows you to work with user events in real time
|
|
- Ability to modify HTTP client
|
|
- [Streaming API](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2/streaming)
|
|
- Receiving public data from VK by specified keywords
|
|
- Ability to modify HTTP client
|
|
- [FOAF](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2/foaf)
|
|
- Machine-readable ontology describing persons
|
|
- Works with users and groups
|
|
- The only place to get page creation date
|
|
- [VK Mini Apps](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2/vkapps)
|
|
- Checking launch parameters
|
|
- Intermediate http handler
|
|
- [Payments API](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2/payments)
|
|
- Processes payment notifications
|
|
- [Marusia Skills](https://pkg.go.dev/github.com/SevereCloud/vksdk/v2/marusia)
|
|
- For creating Marusia Skills
|
|
|
|
## Install
|
|
|
|
```bash
|
|
# go mod init mymodulename
|
|
go get github.com/SevereCloud/vksdk/v2@latest
|
|
```
|
|
|
|
## Use by
|
|
|
|
- [Joe](https://github.com/go-joe/joe) adapter: <https://github.com/tdakkota/joe-vk-adapter>
|
|
- [Logrus](https://github.com/sirupsen/logrus) hook: <https://github.com/SevereCloud/vkrus>
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"log"
|
|
|
|
"github.com/SevereCloud/vksdk/v2/api"
|
|
"github.com/SevereCloud/vksdk/v2/api/params"
|
|
"github.com/SevereCloud/vksdk/v2/events"
|
|
"github.com/SevereCloud/vksdk/v2/longpoll-bot"
|
|
)
|
|
|
|
func main() {
|
|
token := "<TOKEN>" // use os.Getenv("TOKEN")
|
|
vk := api.NewVK(token)
|
|
|
|
// get information about the group
|
|
group, err := vk.GroupsGetByID(nil)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
// Initializing Long Poll
|
|
lp, err := longpoll.NewLongPoll(vk, group[0].ID)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
// New message event
|
|
lp.MessageNew(func(_ context.Context, obj events.MessageNewObject) {
|
|
log.Printf("%d: %s", obj.Message.PeerID, obj.Message.Text)
|
|
|
|
if obj.Message.Text == "ping" {
|
|
b := params.NewMessagesSendBuilder()
|
|
b.Message("pong")
|
|
b.RandomID(0)
|
|
b.PeerID(obj.Message.PeerID)
|
|
|
|
_, err := vk.MessagesSend(b.Params)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
})
|
|
|
|
// Run Bots Long Poll
|
|
log.Println("Start Long Poll")
|
|
if err := lp.Run(); err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
```
|
|
|
|
## LICENSE
|
|
|
|
[](https://app.fossa.io/projects/git%2Bgithub.com%2FSevereCloud%2Fvksdk?ref=badge_large)
|