package
1.6.0
Repository: https://github.com/ancientice/gowarcraft3.git
Documentation: pkg.go.dev

# Functions

Deserialize reads exactly one packet from b and returns it in the proper (deserialized) packet type.
DeserializeWithFactory reads exactly one packet from b and returns it in the proper (deserialized) packet type.
Read exactly one packet from r and returns it in the proper (deserialized) packet type.
ReadWithFactory exactly one packet from r and returns it in the proper (deserialized) packet type.
Serialize packet and returns its byte representation.
Write serializes p and writes it to w.

# Constants

CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
CAPI command identifiers.
Endpoint for websocket connection It is recommended that the certificate is checked to ensure that the common name matches *.classic.blizzard.com.
Message event types.
Message event types.
Message event types.
Message event types.
Message event types.
Message event types.
User attribute keys.
User attribute keys.
User attribute keys.
User attribute keys.
User flags.
User flags.
User flags.
User flags.
User flags.

# Variables

DefaultFactory maps command to matching payload type.
Errors Area Code Reason 8 1 Not Connected to chat 8 2 Bad request 6 5 Request timed out 6 8 Hit rate limit.
Errors Area Code Reason 8 1 Not Connected to chat 8 2 Bad request 6 5 Request timed out 6 8 Hit rate limit.
Errors Area Code Reason 8 1 Not Connected to chat 8 2 Bad request 6 5 Request timed out 6 8 Hit rate limit.
Errors Area Code Reason 8 1 Not Connected to chat 8 2 Bad request 6 5 Request timed out 6 8 Hit rate limit.
Errors Area Code Reason 8 1 Not Connected to chat 8 2 Bad request 6 5 Request timed out 6 8 Hit rate limit.

# Structs

Authenticate payload (Botapiauth.AuthenticateRequest) When connection is established, the client will need to send an authentication request with the API key.
BanUser payload (Botapichat.BanUserRequest) Bans a user from the channel.
Connect payload (Botapichat.ConnectRequest) Connect the bot to the gateway and chat channel.
ConnectEvent payload (Botapichat.ConnectEventRequest).
Disconnect payload (Botapichat.DisconnectRequest) Disconnects the bot from the gateway and chat channel.
DisconnectEvent payload (Botapichat.DisconnectEventRequest).
KickUser payload (Botapichat.KickUserRequest) Kicks a user from the channel.
MessageEvent payload (Botapichat.MessageEventRequest).
Packet structure.
Response payload (*.*Response).
SendEmote payload (Botapichat.SendEmoteRequest) Sends an emote on behalf of a bot.
SendMessage payload (Botapichat.SendMessageRequest) Sends a chat message to the channel.
SendWhisper payload (Botapichat.SendWhisperRequest) Sends a chat message to one user in the channel.
SetModerator payload (Botapichat.SendSetModeratorRequest) Sets the current chat moderator to a member of the current chat.
Status object.
UnbanUser payload (Botapichat.UnbanUserRequest) Un-Bans a user from the channel.
UserAttribute for UserUpdateEvent.
UserLeaveEvent payload (Botapichat.UserLeaveEventRequest).
UserUpdateEvent payload (Botapichat.UserUpdateEvent).

# Interfaces

PayloadFactory returns a struct of the appropiate type for a Payload ID.

# Type aliases

FactoryFunc creates new payload container.
MapFactory implements PayloadFactory using a map.
MessageEventType enum.