api

package

v0.0.0-...-1f70e13 Latest Latest Go to latest Published: May 20, 2023 License: GPL-3.0 Imports: 11 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Api struct {
	// contains filtered or unexported fields
}

Api contains everything required to run the API section of the server.

func NewApi(db database.Db, client discord.Client, hostName, protocol string) Api

NewApi creates a new Api.

func (a Api) DeleteChannel(c *gin.Context)

DeleteChannel deletes ("unsubscribes") a channel from the database.

func (a Api) GuildListMiddleware() gin.HandlerFunc

GuildListMiddleware gets a GuildList using the clients session.

func (a Api) HandleDiscordLogin(c *gin.Context)

HandleDiscordLogin is the endpoint handler for when a user authenticates using Discords OAuth flow.

func (a Api) HandleDiscordLogout(c *gin.Context)

HandleDiscordLogout is for when a user wants to invalidate their session that contains Discord OAuth info.

func (a Api) SessionMiddleware() gin.HandlerFunc

SessionMiddleware checks for and passes along a decrypted users session as a database.SessionRecord.

func (a Api) Stats(c *gin.Context)

Stats is the endpoint handler for statistics derived from collected metrics.

func (a Api) SubscribedChannels(c *gin.Context)

SubscribedChannels returns a list of information about guilds user is authed in that are subscribed to the notification service.

func (a Api) UpdateChannel(c *gin.Context)

UpdateChannel updates information about a channel in the database.

func (a Api) UserInfo(c *gin.Context)

UserInfo is the endpoint for getting the users username and avatar URL.

func (a Api) VerifySession(c *gin.Context)

VerifySession allows the frontend to determine if the user has an active and valid session or not.