project

Documentation

Index

• Variables
• func CheckAliasPattern(alias string) bool
• type Builder
  • func New() *Builder
  • func (b *Builder) Alias(alias string) *Builder
  • func (b *Builder) BasicAuthPassword(basicAuthPassword string) *Builder
  • func (b *Builder) BasicAuthUsername(basicAuthUsername string) *Builder
  • func (b *Builder) Build() (*Project, error)
  • func (b *Builder) Description(description string) *Builder
  • func (b *Builder) ID(id ID) *Builder
  • func (b *Builder) ImageURL(imageURL *url.URL) *Builder
  • func (b *Builder) IsArchived(isArchived bool) *Builder
  • func (b *Builder) IsBasicAuthActive(isBasicAuthActive bool) *Builder
  • func (b *Builder) MustBuild() *Project
  • func (b *Builder) Name(name string) *Builder
  • func (b *Builder) NewID() *Builder
  • func (b *Builder) PublicDescription(publicDescription string) *Builder
  • func (b *Builder) PublicImage(publicImage string) *Builder
  • func (b *Builder) PublicNoIndex(publicNoIndex bool) *Builder
  • func (b *Builder) PublicTitle(publicTitle string) *Builder
  • func (b *Builder) PublishedAt(publishedAt time.Time) *Builder
  • func (b *Builder) PublishmentStatus(publishmentStatus PublishmentStatus) *Builder
  • func (b *Builder) Team(team TeamID) *Builder
  • func (b *Builder) UpdatedAt(updatedAt time.Time) *Builder
  • func (b *Builder) Visualizer(visualizer visualizer.Visualizer) *Builder
• type ID
• type Project
  • func (p *Project) Alias() string
  • func (p *Project) BasicAuthPassword() string
  • func (p *Project) BasicAuthUsername() string
  • func (p *Project) CreatedAt() time.Time
  • func (p *Project) Description() string
  • func (p *Project) ID() ID
  • func (p *Project) ImageURL() *url.URL
  • func (p *Project) IsArchived() bool
  • func (p *Project) IsBasicAuthActive() bool
  • func (p *Project) MatchWithPublicName(name string) bool
  • func (p *Project) Name() string
  • func (p *Project) PublicDescription() string
  • func (p *Project) PublicImage() string
  • func (p *Project) PublicName() string
  • func (p *Project) PublicNoIndex() bool
  • func (p *Project) PublicTitle() string
  • func (p *Project) PublishedAt() time.Time
  • func (p *Project) PublishmentStatus() PublishmentStatus
  • func (p *Project) SetArchived(isArchived bool)
  • func (p *Project) SetBasicAuthPassword(basicAuthPassword string)
  • func (p *Project) SetBasicAuthUsername(basicAuthUsername string)
  • func (p *Project) SetImageURL(imageURL *url.URL)
  • func (p *Project) SetIsBasicAuthActive(isBasicAuthActive bool)
  • func (p *Project) SetPublishedAt(publishedAt time.Time)
  • func (p *Project) SetUpdatedAt(updatedAt time.Time)
  • func (p *Project) Team() TeamID
  • func (p *Project) UpdateAlias(alias string) error
  • func (p *Project) UpdateDescription(description string)
  • func (p *Project) UpdateName(name string)
  • func (p *Project) UpdatePublicDescription(publicDescription string)
  • func (p *Project) UpdatePublicImage(publicImage string)
  • func (p *Project) UpdatePublicNoIndex(publicNoIndex bool)
  • func (p *Project) UpdatePublicTitle(publicTitle string)
  • func (p *Project) UpdatePublishmentStatus(publishmentStatus PublishmentStatus)
  • func (p *Project) UpdateTeam(team TeamID)
  • func (p *Project) UpdateVisualizer(visualizer visualizer.Visualizer)
  • func (p *Project) UpdatedAt() time.Time
  • func (p *Project) Visualizer() visualizer.Visualizer
• type PublishmentStatus
• type TeamID

Variables

var (
	ErrInvalidAlias error = errors.New("invalid alias")
)

var ErrInvalidID = id.ErrInvalidID

var IDFrom = id.ProjectIDFrom

var IDFromRef = id.ProjectIDFromRef

var IDFromRefID = id.ProjectIDFromRefID

var MustID = id.MustProjectID

var MustTeamID = id.MustTeamID

var NewID = id.NewProjectID

var NewTeamID = id.NewTeamID

var TeamIDFrom = id.TeamIDFrom

var TeamIDFromRef = id.TeamIDFromRef

var TeamIDFromRefID = id.TeamIDFromRefID

Functions

func CheckAliasPattern

func CheckAliasPattern(alias string) bool

Types

type Builder

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

func New

func New() *Builder

func (*Builder) Alias

func (b *Builder) Alias(alias string) *Builder

func (*Builder) BasicAuthPassword

func (b *Builder) BasicAuthPassword(basicAuthPassword string) *Builder

func (*Builder) BasicAuthUsername

func (b *Builder) BasicAuthUsername(basicAuthUsername string) *Builder

func (*Builder) Build

func (b *Builder) Build() (*Project, error)

func (*Builder) Description

func (b *Builder) Description(description string) *Builder

func (*Builder) ID

func (b *Builder) ID(id ID) *Builder

func (*Builder) ImageURL

func (b *Builder) ImageURL(imageURL *url.URL) *Builder

func (*Builder) IsArchived

func (b *Builder) IsArchived(isArchived bool) *Builder

func (*Builder) IsBasicAuthActive

func (b *Builder) IsBasicAuthActive(isBasicAuthActive bool) *Builder

func (*Builder) MustBuild

func (b *Builder) MustBuild() *Project

func (*Builder) Name

func (b *Builder) Name(name string) *Builder

func (*Builder) NewID

func (b *Builder) NewID() *Builder

func (*Builder) PublicDescription

func (b *Builder) PublicDescription(publicDescription string) *Builder

func (*Builder) PublicImage

func (b *Builder) PublicImage(publicImage string) *Builder

func (*Builder) PublicNoIndex

func (b *Builder) PublicNoIndex(publicNoIndex bool) *Builder

func (*Builder) PublicTitle

func (b *Builder) PublicTitle(publicTitle string) *Builder

func (*Builder) PublishedAt

func (b *Builder) PublishedAt(publishedAt time.Time) *Builder

func (*Builder) PublishmentStatus

func (b *Builder) PublishmentStatus(publishmentStatus PublishmentStatus) *Builder

func (*Builder) Team

func (b *Builder) Team(team TeamID) *Builder

func (*Builder) UpdatedAt

func (b *Builder) UpdatedAt(updatedAt time.Time) *Builder

func (*Builder) Visualizer

func (b *Builder) Visualizer(visualizer visualizer.Visualizer) *Builder

type ID

type ID = id.ProjectID

type Project

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

func (*Project) Alias

func (p *Project) Alias() string

func (*Project) BasicAuthPassword

func (p *Project) BasicAuthPassword() string

func (*Project) BasicAuthUsername

func (p *Project) BasicAuthUsername() string

func (*Project) CreatedAt

func (p *Project) CreatedAt() time.Time

func (*Project) Description

func (p *Project) Description() string

func (*Project) ID

func (p *Project) ID() ID

func (*Project) ImageURL

func (p *Project) ImageURL() *url.URL

func (*Project) IsArchived

func (p *Project) IsArchived() bool

func (*Project) IsBasicAuthActive

func (p *Project) IsBasicAuthActive() bool

func (*Project) MatchWithPublicName

func (p *Project) MatchWithPublicName(name string) bool

func (*Project) Name

func (p *Project) Name() string

func (*Project) PublicDescription

func (p *Project) PublicDescription() string

func (*Project) PublicImage

func (p *Project) PublicImage() string

func (*Project) PublicName

func (p *Project) PublicName() string

func (*Project) PublicNoIndex

func (p *Project) PublicNoIndex() bool

func (*Project) PublicTitle

func (p *Project) PublicTitle() string

func (*Project) PublishedAt

func (p *Project) PublishedAt() time.Time

func (*Project) PublishmentStatus

func (p *Project) PublishmentStatus() PublishmentStatus

func (*Project) SetArchived

func (p *Project) SetArchived(isArchived bool)

func (*Project) SetBasicAuthPassword

func (p *Project) SetBasicAuthPassword(basicAuthPassword string)

func (*Project) SetBasicAuthUsername

func (p *Project) SetBasicAuthUsername(basicAuthUsername string)

func (*Project) SetImageURL

func (p *Project) SetImageURL(imageURL *url.URL)

func (*Project) SetIsBasicAuthActive

func (p *Project) SetIsBasicAuthActive(isBasicAuthActive bool)

func (*Project) SetPublishedAt

func (p *Project) SetPublishedAt(publishedAt time.Time)

func (*Project) SetUpdatedAt

func (p *Project) SetUpdatedAt(updatedAt time.Time)

func (*Project) Team

func (p *Project) Team() TeamID

func (*Project) UpdateAlias

func (p *Project) UpdateAlias(alias string) error

func (*Project) UpdateDescription

func (p *Project) UpdateDescription(description string)

func (*Project) UpdateName

func (p *Project) UpdateName(name string)

func (*Project) UpdatePublicDescription

func (p *Project) UpdatePublicDescription(publicDescription string)

func (*Project) UpdatePublicImage

func (p *Project) UpdatePublicImage(publicImage string)

func (*Project) UpdatePublicNoIndex

func (p *Project) UpdatePublicNoIndex(publicNoIndex bool)

func (*Project) UpdatePublicTitle

func (p *Project) UpdatePublicTitle(publicTitle string)

func (*Project) UpdatePublishmentStatus

func (p *Project) UpdatePublishmentStatus(publishmentStatus PublishmentStatus)

func (*Project) UpdateTeam

func (p *Project) UpdateTeam(team TeamID)

func (*Project) UpdateVisualizer

func (p *Project) UpdateVisualizer(visualizer visualizer.Visualizer)

func (*Project) UpdatedAt

func (p *Project) UpdatedAt() time.Time

func (*Project) Visualizer

func (p *Project) Visualizer() visualizer.Visualizer

type PublishmentStatus

type PublishmentStatus string

const (
	PublishmentStatusPublic PublishmentStatus = "public"

	PublishmentStatusLimited PublishmentStatus = "limited"

	PublishmentStatusPrivate PublishmentStatus = "private"
)

type TeamID

type TeamID = id.TeamID