package
4.3.12+incompatible
Repository: https://github.com/jpholanda/khan.git
Documentation: pkg.go.dev
# Functions
ApplyForMembershipHandler is the handler responsible for applying for new memberships.
ApproveOrDenyMembershipApplicationHandler is the handler responsible for approving or denying a membership invitation.
ApproveOrDenyMembershipInvitationHandler is the handler responsible for approving or denying a membership invitation.
CreateClanHandler is the handler responsible for creating new clans.
CreateGameHandler is the handler responsible for creating new games.
CreateHookHandler is the handler responsible for creating new hooks.
CreatePlayerHandler is the handler responsible for creating new players.
DeleteMembershipHandler is the handler responsible for deleting a member.
FailWith fails with the specified message.
FailWithError fails with the specified error.
GetApp returns a new Khan API Application.
GetRequestBody from echo context.
GetRequestJSON as the specified interface from echo context.
GetTX returns new relic transaction.
HealthCheckHandler is the handler responsible for validating that the app is still up.
InviteForMembershipHandler is the handler responsible for creating new memberships.
LeaveClanHandler is the handler responsible for changing the clan ownership when the owner leaves it.
ListClansHandler is the handler responsible for returning a list of all clans.
LoadJSONPayload loads the JSON payload to the given struct validating all fields are not null.
NewBodyExtractionMiddleware with API version.
NewDispatcher creates a new dispatcher available to our app.
NewLoggerMiddleware returns the logger middleware.
NewNewRelicMiddleware returns the logger middleware.
NewRecoveryMiddleware returns a configured middleware.
NewSentryMiddleware returns a new sentry middleware.
NewValidation for validating structs.
NewVersionMiddleware with API version.
PromoteOrDemoteMembershipHandler is the handler responsible for promoting or demoting a member.
RemoveHookHandler is the handler responsible for removing existing hooks.
RetrieveClanHandler is the handler responsible for returning details for a given clan.
RetrieveClanMembersHandler retrieves only the clan users.
RetrieveClansSummariesHandler is the handler responsible for returning details summary for a given list of clans.
RetrieveClanSummaryHandler is the handler responsible for returning details summary for a given clan.
RetrievePlayerHandler is the handler responsible for returning details for a given player.
SearchClansHandler is the handler responsible for searching for clans.
SetRetrieveClanHandlerConfigurationDefaults sets the default configs for RetrieveClanHandler.
StatusHandler is the handler responsible for reporting khan status.
SucceedWith sends payload to user with status 200.
TransferOwnershipHandler is the handler responsible for transferring the clan ownership to another clan member.
UpdateClanHandler is the handler responsible for updating existing clans.
UpdateGameHandler is the handler responsible for updating existing.
UpdatePlayerHandler is the handler responsible for updating existing.
ValidatePayload for any validatable payload.
WithSegment adds a segment to new relic transaction.
# Structs
App is a struct that represents a Khan API Application.
ApplyForMembershipPayload maps the payload required for the Apply for Membership route.
ApproveOrDenyMembershipInvitationPayload maps the payload required for Approving or Denying a membership.
BasePayloadWithRequestorAndPlayerPublicIDs maps the payload required for many routes.
BodyExtractionMiddleware extracts the body.
CreateClanPayload maps the payload for the Create Clan route.
CreateGamePayload maps the payload required for the Create game route.
CreatePlayerPayload maps the payload for the Create Player route.
Dispatcher is responsible for sending web hooks to workers.
HookPayload maps the payload required to create or update hooks.
InviteForMembershipPayload maps the payload required for the Invite for Membership route.
LoggerMiddleware is responsible for logging to Zap all requests.
NewRelicMiddleware is responsible for logging to Zap all requests.
RecoveryMiddleware recovers from errors.
SentryMiddleware is responsible for sending all exceptions to sentry.
TransferClanOwnershipPayload maps the payload for the Transfer Clan Ownership route.
UpdateClanPayload maps the payload for the Update Clan route.
UpdateGamePayload maps the payload required for the Update game route.
UpdatePlayerPayload maps the payload for the Update Player route.
Validation struct.
VersionMiddleware inserts the current version in all requests.
# Interfaces
EasyJSONMarshaler describes a struct able to marshal json.
EasyJSONUnmarshaler describes a struct able to unmarshal json.
Validatable indicates that a struct can be validated.