Categorygithub.com/FlameInTheDark/guildrone
modulepackage
0.3.5
Repository: https://github.com/flameinthedark/guildrone.git
Documentation: pkg.go.dev

# README

GuilDrone

Go Reference Release Go Report Card codebeat badge

This is a Guilded chat library based on discordgo by bwmarrin.

This is basically bwmarrin's code, so please leave all thanks to him.

Getting Started

Installing

This assumes you already have a working Go environment, if not please see this page first.

go get will always pull the latest tagged release from the master branch.

go get github.com/FlameInTheDark/guildrone

Usage

Import the package into your project.

import "github.com/FlameInTheDark/guildrone"

Construct a new Guilded client which can be used to access the variety of Guilded API functions and to set callback functions for Guilded events.

guilded, err := guildrone.New("authentication token")

See Documentation and Examples below for more detailed information.

# Packages

No description provided by the author
No description provided by the author

# Functions

New creates a new Guilded session with provided token.

# Constants

FailedHeartbeatAcks is the Number of heartbeat intervals to wait until forcing a connection restart.
LogDebug level is for very detailed non-error activity.
LogError level is used for critical errors that could lead to data loss or panic that would not be returned to a calling function.
LogInformational level is used for normal non-error activity.
LogWarning level is used for very abnormal events and errors that are also returned to a calling function.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
VERSION of Guildrone, follows Semantic Versioning.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
All error constants.
All error constants.
ErrWSAlreadyOpen is thrown when you attempt to open a websocket that already is open.
ErrWSNotFound is thrown when you attempt to use a websocket that doesn't exist.
Logger can be used to replace the standard logging for guildrone.
Marshal defines function used to encode JSON payloads.
Unmarshal defines function used to decode JSON payloads.

# Structs

An APIErrorMessage is an api error message returned from Guilded.
BotUser is a bot data structure.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ChannelEvent is the request body for creating/updating a channel event.
ChannelEventsRequest is the request body for listing channel events.
ChannelForumTopicCreate is the request body for creating a forum topic.
ChannelForumTopicUpdate is the request body for updating a forum topic.
ChannelListItem is the request body for creating or updating a channel list item.
No description provided by the author
No description provided by the author
No description provided by the author
ChatEmbed stores the data of an embed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ChatMessage stores the data of a chat message.
Is the data for the ChatMessageCreated event.
No description provided by the author
No description provided by the author
Connect is the data for a Connect event.
Disconnect is the data for a Disconnect event.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Emote is a struct that represents a reaction emote.
Event provides a basic initial struct for all websocket events.
ForumTopic is the forum topic model.
No description provided by the author
No description provided by the author
ForumTopicSummary is the forum topic summary model.
No description provided by the author
ListItem is a struct that represents a list item.
No description provided by the author
No description provided by the author
No description provided by the author
ListItemNote is a struct that represents a list item note.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Mentions stores the data of a mention.
No description provided by the author
MessageCreate is a request body for creating a message.
MessagesRequest is a request body for getting messages.
MessageUpdate is a request body for updating a message.
RateLimit is the data for a RateLimit event.
RateLimitError is returned when a request exceeds a rate limit and ShouldRetryOnRateLimit is false.
Reaction is a struct that represents a reaction.
No description provided by the author
RESTError stores error information about a request with a bad response code.
Resume is the data for a Resume event.
Server represents a server in Guilded.
No description provided by the author
ServerChannelCreate is the request body for creating a channel.
ServerChannelUpdate is the request body for updating a channel.
No description provided by the author
No description provided by the author
ServerMemberBanCreate is the request body for banning a user from a server.
ServerMemberNicknameUpdate is the request body for updating a server member nickname.
ServerSocialLink is the request body for retrieving server member social link.
ServerXPSet is the request body for set a server member xp.
ServerXPUpdate is the request body for updating a server member xp.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
User stores the data of a user.
No description provided by the author
No description provided by the author
No description provided by the author
WebhookCreate is the request body for creating a webhook.
WebhookUpdate is the request body for updating a webhook.

# Interfaces

EventHandler is an interface for Guilded events.
EventInterfaceProvider is an interface for providing empty interfaces for Guilded events.

# Type aliases

MessageType is the type of message.
No description provided by the author
ServerChannelType is a sting that represents the type of a server channel.
No description provided by the author
No description provided by the author