README
¶
MasterPoll Golang SDK
Introduction
masterpoll-go-sdk is a new library made in collaboration with MasterPoll Telegram bot to manage their web APIs comfortably in Golang without writing it all by yourself.
MasterPoll links
Getting started
Install this repository
Install masterpoll-go-sdk on your pc using:
go get github.com/ErikPelli/masterpoll-go-sdk
Get an API Key
Before starting to use this library, you must get your own token to use the MasterPoll API, writing /api to MasterPoll Telegram bot.
Read the documentation
You can find the documentation for this library at godoc.org.
Understand the library structure
Before starting to use this library, you must create a variable of type MasterPoll, passing as a parameter the API key.
Now, you can create your poll (using MasterPollvar.CreatePoll function, passing a (PollType)Create type that has been set before.
You could also use GetPoll function that returns a Poll type (a map[string]interface{}), and in masterpoll-go-sdk package there are functions to edit its fields on MasterPoll web database (using the Rest API provided by them).
Check our examples
You can take a cue from all the examples in the cmd folder, to better understand how to integrate MasterPoll into your project, using the various functions available.
Let's start!
Now that you understand how it all works, you can integrate MasterPoll into your project!
⚠️ Archiving
Masterpoll telegram bot is no longer available, so this repository has been archived.
Documentation
¶
Overview ¶
Package to manage MasterPoll API using polls' package types.
Index ¶
- func AddPollVote(poll *polls.Poll, value interface{}) error
- func ClosePoll(poll *polls.Poll) error
- func DeletePoll(poll *polls.Poll) error
- func EditPoll(poll *polls.Poll, privacy bool, settings *polls.Settings) error
- func EditPollVote(poll *polls.Poll, value interface{}) error
- func GetGraph(poll *polls.Poll, dark, bar bool) (string, error)
- func GetStatus() bool
- func OpenPoll(poll *polls.Poll) error
- func RemovePollVote(poll *polls.Poll, choice string) error
- type MasterPoll
- func (MPoll *MasterPoll) CreatePoll(pollSend interface{}) (int, error)
- func (MPoll *MasterPoll) GetActivePolls() ([]*polls.Poll, error)
- func (MPoll *MasterPoll) GetAllPolls() ([]*polls.Poll, error)
- func (MPoll *MasterPoll) GetMe() ([]string, error)
- func (MPoll *MasterPoll) GetPoll(pollId int) (*polls.Poll, error)
- func (MPoll *MasterPoll) GetSubscribers() (int, error)
- func (MPoll *MasterPoll) SetAPI(APIKey string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddPollVote ¶
AddPollVote adds your vote to a poll. value param by poll type: vote, doodle, limited doodle, quiz and board -> string rating -> int between 1 and 10 participation -> nil (It isn't required)
func DeletePoll ¶
DeletePoll deletes the poll definitively (this action is irreversible).
func EditPollVote ¶
EditPollVote edits your vote in a poll. value param by poll type: vote, quiz and board -> string rating -> int between 1 and 10 participation -> bool (true or false) doodle and limited doodle -> not supported
Types ¶
type MasterPoll ¶
type MasterPoll string
func MasterPollNew ¶
func MasterPollNew(APIKey string) *MasterPoll
Create a new MasterPoll with an API key.
func (*MasterPoll) CreatePoll ¶
func (MPoll *MasterPoll) CreatePoll(pollSend interface{}) (int, error)
Create a new poll with a PollSend interface object and return poll_id as int.
func (*MasterPoll) GetActivePolls ¶
func (MPoll *MasterPoll) GetActivePolls() ([]*polls.Poll, error)
GetActivePolls returns all your polls currently active in MasterPoll database.
func (*MasterPoll) GetAllPolls ¶
func (MPoll *MasterPoll) GetAllPolls() ([]*polls.Poll, error)
GetActivePolls returns all your polls in MasterPoll database.
func (*MasterPoll) GetMe ¶
func (MPoll *MasterPoll) GetMe() ([]string, error)
GetMe() returns your personal information saved in bot database as a []string. 0 -> first_name, 1 -> last_name, 2 -> username, 3 -> language.
func (*MasterPoll) GetPoll ¶
func (MPoll *MasterPoll) GetPoll(pollId int) (*polls.Poll, error)
GetPoll gets an existent poll from its id.
func (*MasterPoll) GetSubscribers ¶
func (MPoll *MasterPoll) GetSubscribers() (int, error)
GetSubscribers() returns bot subscribers number
func (*MasterPoll) SetAPI ¶
func (MPoll *MasterPoll) SetAPI(APIKey string)
Change API key of MasterPoll.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Package to manage errors produced by other packages.
|
Package to manage errors produced by other packages. |
|
internal
|
|
|
Package polls provides types to manage polls and some functions to create or manage them.
|
Package polls provides types to manage polls and some functions to create or manage them. |