learning_content_client

Documentation

Index

• type Area
• type Challenge
• type Client
  • func New(options ...ClientOption) *Client
  • func (c *Client) GetLatestRelease() (*Release, error)
• type ClientOption
  • func WithApiKey(apiKey string) ClientOption
  • func WithApiURL(apiURL string) ClientOption
• type Competence
• type Content
• type Course
• type Framework
• type Release
• type Skill
• type Thematic
• type Tube
• type Tutorial

Types

type Area

type Area struct {
	Id          string `json:"id"`
	Code        string `json:"code"`
	TitleFrFr   string `json:"titleFrFr"`
	Name        string `json:"name"`
	FrameworkId string `json:"frameworkId"`
	TitleEnUs   string `json:"titleEnUs"`
	Color       string `json:"color"`
}

type Challenge

type Challenge struct {
	Id                     string   `json:"id"`
	Instruction            string   `json:"instruction"`
	Proposals              string   `json:"proposals"`
	Type                   string   `json:"type"`
	Solution               string   `json:"solution"`
	T1Status               bool     `json:"t1Status"`
	T2Status               bool     `json:"t2Status"`
	T3Status               bool     `json:"t3Status"`
	Status                 string   `json:"status"`
	SkillId                string   `json:"skillId"`
	CompetenceId           string   `json:"competenceId"`
	Format                 string   `json:"format"`
	AutoReply              bool     `json:"autoReply"`
	Locales                []string `json:"locales"`
	AlternativeInstruction string   `json:"alternativeInstruction"`
	Genealogy              string   `json:"genealogy"`
	Responsive             string   `json:"responsive"`
	EmbedUrl               string   `json:"embedUrl"`
	EmbedTitle             string   `json:"embedTitle"`
	EmbedHeight            int      `json:"embedHeight"`
	IllustrationUrl        string   `json:"illustrationUrl"`
	Attachments            []string `json:"attachments"`
	Focusable              bool     `json:"focusable"`
	SolutionToDisplay      string   `json:"solutionToDisplay"`
	IllustrationAlt        string   `json:"illustrationAlt"`
	Timer                  int      `json:"timer"`
	Delta                  float64  `json:"delta"`
	Alpha                  float64  `json:"alpha"`
}

type Client

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

func New

func New(options ...ClientOption) *Client

func (*Client) GetLatestRelease

func (c *Client) GetLatestRelease() (*Release, error)

type ClientOption

type ClientOption func(c *Client)

func WithApiKey

func WithApiKey(apiKey string) ClientOption

func WithApiURL

func WithApiURL(apiURL string) ClientOption

type Competence

type Competence struct {
	Id              string `json:"id"`
	NameFrFr        string `json:"nameFrFr"`
	Index           string `json:"index"`
	AreaId          string `json:"areaId"`
	Origin          string `json:"origin"`
	DescriptionFrFr string `json:"descriptionFrFr"`
	NameEnUs        string `json:"nameEnUs"`
	DescriptionEnUs string `json:"descriptionEnUs"`
	Name            string `json:"name"`
	Description     string `json:"description"`
}

type Content

type Content struct {
	Areas       []*Area       `json:"areas"`
	Challenges  []*Challenge  `json:"challenges"`
	Competences []*Competence `json:"competences"`
	Courses     []*Course     `json:"courses"`
	Frameworks  []*Framework  `json:"frameworks"`
	Skills      []*Skill      `json:"skills"`
	Thematics   []*Thematic   `json:"thematics"`
	Tutorials   []*Tutorial   `json:"tutorials"`
	Tubes       []*Tube       `json:"tubes"`
}

type Course

type Course struct {
	Id          string   `json:"id"`
	Name        string   `json:"name"`
	Challenges  []string `json:"challenges"`
	Description string   `json:"description"`
	ImageUrl    string   `json:"imageUrl"`
	Competences []string `json:"competences"`
}

type Framework

type Framework struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

type Release

type Release struct {
	Id        int       `json:"id"`
	CreatedAt time.Time `json:"createdAt"`
	Content   *Content  `json:"content"`
}

type Skill

type Skill struct {
	Id                      string   `json:"id"`
	Name                    string   `json:"name"`
	HintFrFr                string   `json:"hintFrFr"`
	HintEnUs                string   `json:"hintEnUs"`
	HintStatus              string   `json:"hintStatus"`
	TutorialIds             []string `json:"tutorialIds"`
	LearningMoreTutorialIds []string `json:"learningMoreTutorialIds"`
	PixValue                int      `json:"pixValue"`
	CompetenceId            string   `json:"competenceId"`
	Status                  string   `json:"status"`
	TubeId                  string   `json:"tubeId"`
	Version                 int      `json:"version"`
}

type Thematic

type Thematic struct {
	Id           string `json:"id"`
	Name         string `json:"name"`
	CompetenceId string `json:"competenceId"`
	Index        int    `json:"index"`
}

type Tube

type Tube struct {
	Id                       string `json:"id"`
	Name                     string `json:"name"`
	Title                    string `json:"title"`
	Description              string `json:"description"`
	CompetenceId             string `json:"competenceId"`
	PracticalTitleFrFr       string `json:"practicalTitleFrFr"`
	PracticalDescriptionFrFr string `json:"practicalDescriptionFrFr"`
	PracticalTitleEnUs       string `json:"practicalTitleEnUs"`
	PracticalDescriptionEnUs string `json:"practicalDescriptionEnUs"`
}

type Tutorial

type Tutorial struct {
	Id       string `json:"id"`
	Duration string `json:"duration"`
	Format   string `json:"format"`
	Link     string `json:"link"`
	Source   string `json:"source"`
	Title    string `json:"title"`
	Locale   string `json:"locale"`
}