package
1.0.31
Repository: https://github.com/script-development/rt-cv.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

CheckAPIKeysExists checks if apiKeys are valid IDs of existing keys.
CheckDashboardKeyExists checks weather the required system keys are available and if not creates them.
ExampleCV is a cv that can be used for demonstrative purposes.
GetActualMatchActiveProfiles returns that we can actually use Matches are not really helpfull if no desiredProfessions, professionExperienced, driversLicenses or educations is set Matches without an onMatch property are useless as we can't send the match anywhere.
GetActualMatchActiveProfilesCount does the same as GetActualMatchActiveProfiles but only returns the number of found profiles.
GetAPIKey returns a single api key.
GetAPIKeys returns all the keys registered in the database.
GetListsProfiles returns all profiles that can be used for the cv lists functionality.
GetOnMatchHooks returns all the onMatchHooks.
GetProfile returns a profile by id.
GetProfiles returns all profiles from the database.
GetProfilesCount returns the amount of profiles in the database.
GetScraperAPIKeys returns all the keys with scraper roles registered in the database.
LastBackupTime returns the last time of a created backup a zero time is returned when there is no backup found a zero time can be detected using the (time.Time).IsZero() method.
NeedToCreateBackup returns whether a backup is needed.
SetLastBackupToNow sets the last backup time to now.

# Constants

APIKeyRoleAdmin Currently unused = 16.
APIKeyRoleController can control the server = 4.
APIKeyRoleDashboard can access the dashboard and modify server state = 8.
APIKeyRoleInformationObtainer can obtain information the server has = 2.
APIKeyRoleScraper can insert scraped data = 1.
DataKindList is the data kind for when a list of cvs is matched.
DataKindMatch is the data kind for when a match is found.
The lanague levels available.
The lanague levels available.
The lanague levels available.
The lanague levels available.

# Variables

APIKeyRoleAll contains all of the above roles and thus can access everything.
APIKeyRoleAllArray is an array of all roles.
ErrScraperNoPublicKey is used when you want to add a user to a scraper but the scraper has no public key yet used to encrypt the password.

# Structs

APIKey contains a registered API key.
APIKeyInfo contains information about an API key This key can be send to someone safely without exposing the key To generate this object use the (*APIKey).Info method.
APIRole contains information about a APIKeyRole.
Backup tells when a backup was created.
Competence is an activity a user is "good" at.
CV contains all information that belongs to a curriculum vitae TODO check the json removed fields if we actually should use them.
Education is something a user has followed.
GetOnMatchHooksProps contains the properties for GetOnMatchHooks.
Header is a struct that contains a http header.
Interest contains a job the user is interested in.
Language is a language a user can speak.
Match contains information about a match We add omitempty to a lot of fields as it saves a lot of space in the database.
OnMatchHook can hook onto the matching process and call API calls in case of matches.
PersonalDetails contains personal info.
Profile contains all the information about a search profile.
ProfileDriversLicense contains the drivers license name.
ProfileDutchZipcode is dutch zipcode range limited to the number.
ProfileEducation contains information about an education.
ProfileOnMatch defines what should happen when a profile is matched to a CV.
ProfileProfession contains information about a proffession.
ProfileSendEmailData only contains an email address atm.
ScraperLoginUser defines a user that can be used by a scraper to login into a scraped website.
ScraperLoginUsers defines all the users a scraper can use.
StatusCodeError is an error thrown by (*OnMatchHook).Call() when the status code is >= 400.
WorkExperience is experience in work.

# Type aliases

APIKeyRole is a role that tells what someone can and can't do Roles can be combined together using bit sifting For example: APIKeyRoleScraper | APIKeyRoleInformationObtainer // Is a valid APIKeyRole that represends 2 rules.
DataKind deinfes the kind of data that is being sent to the hook.
Educations conatins a list of educations and makes it sortable.
LanguageLevel is something that i'm not sure what it is.
WorkExperiences conatins a list of Work experiences and makes it sortable.