status

Documentation

Index

• Constants
• Variables
• type CredentialStatus
• type Status
  • func New() *Status
  • func (s *Status) Display() string
• type T

Constants

const (
	FailureCode = -1
	SuccessCode = 1
)

Status Codes when querying data

const (
	ManagerRemoveFailure   = "unable to remove manager"
	ManagerAdditionFailure = "unable to add manager"
	ManagerRemoveSuccess   = "successfully removed manager"
	ManagerAdditionSuccess = "successfully added manager"
)

Manager addition/removal status messages

const (
	TagToggleSuccess = "tag toggled"
	TagCreated       = "successfully created tag"
	TagsCreated      = "successfully created tags"
	TagExists        = "tag already exists"
	TagsUpdated      = "tags updated"
	TagsFound        = "tags found"
	TagNotFound      = "tag doesn't exist"
)

Tag status messages

const (
	TokenPairGenerateSuccess = "generated new token pair"
	SignupSuccess            = "signup successful"
	SignupFailure            = "unable to sign up user"
	LoginSuccess             = "successfully logged in"
	LoginFailure             = "username or password is incorrect"
	UsernameExists           = "username already exists"
	UsernameAlphaNum         = "username must start with a letter and can only contain the following characters: a-zA-Z0-9_ and must be 50 characters or less"
	ValidEmail               = "must be a valid email"
	EmailExists              = "email already exists"
	PasswordRequired         = "a password is required"
	LogoutSuccess            = "successfully logged out"
	LogoutFailure            = "unable to logout user"
)

Authentication status messages

const (
	PasswordUpdateSuccess = "successfully updated password"
	PasswordUpdateFailure = "unable to update password"
	EmailSendSuccess      = "successfully sent email if user exists"
)

Password reset status messages

const (
	GetFilteredNonSwipedClubsSuccess = "obtained all filtered non swiped clubs"
	GetAllClubsSwipedSuccess         = "obtained all swiped clubs"
	ClubSwipeSuccess                 = "successfully swiped club"
	ClubUnswipeSuccess               = "successfully unswiped club"
	ClubPromoteSuccess               = "successfully promoted new owner"
	ClubPromoteSelfFailure           = "you can't promote yourself to be the club owner if you're already the owner"
	ClubPromoteOwnerFailure          = "you must be the owner of the club in order to promote a new owner"
	ClubPromoteNeedManager           = "the user you're trying to promote must be a club manager"
	LeaveClubFailure                 = "sorry, only managers can leave the club. If you wish to do so, please promote another owner for this club"
	LeaveClubSuccess                 = "successfully left club"
	ClubAlreadyActive                = "sorry, this club is already active"
	GetClubManagerSuccess            = "retrieved all club managers"
	ToggleUserSuccess                = "toggled user"
	UserFound                        = "user found"
	UserNotFound                     = "user not found"
	ClubFound                        = "club found"
	ClubEventFound                   = "all club events found"
	ClubNotFound                     = "club not found"
	ClubCreationSuccess              = "club successfully created"
	ClubCreationFailure              = "unable to create club"
	ClubUpdateSuccess                = "successfully updated club"
	ClubToggleSuccess                = "toggled club"
	ClubUpdateFailure                = "unable to update club"
	GetNonApprovedUsersSuccess       = "retrieved all users that require approval"
	GetNonApprovedClubsSuccess       = "retrieved all clubs that require approval"
)

User & Club status messages

const (
	ManagerOwnerRequired = "you must be a manager or owner of the club"
	AdminRequired        = "please contact an administrator"
	InvalidTxtFile       = "invalid file: A .txt file is required"
	FileNotFound         = "file doesn't exist"
	UserNotApproved      = "sorry, your account has not been approved yet"
)

Admin status messages

const (
	CreateEventSuccess         = "successfully created event"
	CreateEventFailure         = "unable to create event"
	UpdateEventSuccess         = "successfully updated event"
	UpdateEventFailure         = "unable to update event"
	EventNameConstraint        = "event name must be at least 1 character and a maximum of 50 characters"
	EventDescriptionConstraint = "event description must be a maximum of 300 characters or less"
	EventLocationConstraint    = "event location must be a maximum of 100 characters or less"
	EventFeeConstraint         = "fee must be greater or equal to 0"
	EventDateTimeConstraint    = "datetime must be in the RFC3339 format and the event must occur later than the current time"
	EventFound                 = "event found"
	EventNotFound              = "event not found"
	EventDeleted               = "event deleted"
	GetAllEventsFailure        = "unable to get all events"
	AllEventsFound             = "all events found"
	EventUnattendSuccess       = "event unattended"
	EventAttendSuccess         = "event attended"
)

Events status messages

const (
	InvalidPhotoSize   = "invalid file: A photo of 10 MB or less is required"
	InvalidPhotoFormat = "invalid file: A .jpg or .png file of 10 MB or less is required"
	FileUploadSuccess  = "successfully uploaded file"
	ClubPhotoNotFound  = "unable to find a photo for the club"
)

Photo upload status messages

const (
	HashErr     = "hashing Error"
	ErrTokenGen = "token generation error"
)

Hashing status messages

Variables

var ErrGeneric = "an error occurred"

ErrGeneric represents an generic error that occurred

Types

type CredentialStatus

type CredentialStatus struct {
	Username string `json:"username"`
	Email    string `json:"email"`
	Password string `json:"password"`
}

CredentialStatus - Listing out requirements for a signup to be successfully created

type Status

type Status struct {
	// Codes will either be returned as 1 or -1
	// 1 - Success
	// -1 - Failure
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}

Status Struct used as the standard response when querying the API

func New

func New() *Status

New - Creates a new basic status By default, the status code will be a FailureCode (i.e. -1)

func (*Status) Display

func (s *Status) Display() string

Display - Returning the JSON representation of a struct.

type T

type T struct{}

T - Basic generic struct for any data fetched