project

Documentation

Index

• Variables
• func CheckAliasPattern(alias string) bool
• type Builder
  • func New() *Builder
  • func (b *Builder) Alias(alias 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) MustBuild() *Project
  • func (b *Builder) Name(name string) *Builder
  • func (b *Builder) NewID() *Builder
  • func (b *Builder) Publication(publication *Publication) *Builder
  • func (b *Builder) RequestRoles(requestRoles []workspace.Role) *Builder
  • func (b *Builder) UpdatedAt(updatedAt time.Time) *Builder
  • func (b *Builder) Workspace(team accountdomain.WorkspaceID) *Builder
• type ID
• type IDList
• type IDOrAlias
  • func (i IDOrAlias) Alias() *string
  • func (i IDOrAlias) ID() *ID
• type List
  • func (l List) Clone() List
  • func (l List) SortByID() List
• type Project
  • func (p *Project) Alias() string
  • func (p *Project) Clone() *Project
  • 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) Name() string
  • func (p *Project) Publication() *Publication
  • func (p *Project) RequestRoles() []workspace.Role
  • func (p *Project) SetImageURL(imageURL *url.URL)
  • func (p *Project) SetPublication(publication *Publication)
  • func (p *Project) SetRequestRoles(sr []workspace.Role)
  • func (p *Project) SetUpdatedAt(updatedAt time.Time)
  • func (p *Project) UpdateAlias(alias string) error
  • func (p *Project) UpdateDescription(description string)
  • func (p *Project) UpdateName(name string)
  • func (p *Project) UpdateTeam(team accountdomain.WorkspaceID)
  • func (p *Project) UpdatedAt() time.Time
  • func (p *Project) Workspace() accountdomain.WorkspaceID
• type Publication
  • func NewPublication(scope PublicationScope, assetPublic bool) *Publication
  • func NewPublicationWithToken(scope PublicationScope, assetPublic bool, token string) *Publication
  • func (p *Publication) AssetPublic() bool
  • func (p *Publication) Clone() *Publication
  • func (p *Publication) GenerateToken()
  • func (p *Publication) Scope() PublicationScope
  • func (p *Publication) SetAssetPublic(assetPublic bool)
  • func (p *Publication) SetScope(scope PublicationScope)
  • func (p *Publication) Token() string
• type PublicationScope
• type WorkspaceID

Variables

var (
	ErrInvalidAlias error = rerror.NewE(i18n.T("invalid alias"))
)

var ErrInvalidID = id.ErrInvalidID

var IDFrom = id.ProjectIDFrom

var IDFromRef = id.ProjectIDFromRef

var MustID = id.MustProjectID

var MustWorkspaceID = id.MustWorkspaceID

var NewID = id.NewProjectID

var NewWorkspaceID = accountdomain.NewWorkspaceID

var WorkspaceIDFrom = id.WorkspaceIDFrom

var WorkspaceIDFromRef = id.WorkspaceIDFromRef

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) 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) 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) Publication

func (b *Builder) Publication(publication *Publication) *Builder

func (*Builder) RequestRoles

func (b *Builder) RequestRoles(requestRoles []workspace.Role) *Builder

func (*Builder) UpdatedAt

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

func (*Builder) Workspace

func (b *Builder) Workspace(team accountdomain.WorkspaceID) *Builder

type ID

type ID = id.ProjectID

type IDList

type IDList = id.ProjectIDList

type IDOrAlias

type IDOrAlias string

func (IDOrAlias) Alias

func (i IDOrAlias) Alias() *string

func (IDOrAlias) ID

func (i IDOrAlias) ID() *ID

type List

type List []*Project

func (List) Clone

func (l List) Clone() List

func (List) SortByID

func (l List) SortByID() List

type Project

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

func (*Project) Alias

func (p *Project) Alias() string

func (*Project) Clone

func (p *Project) Clone() *Project

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) Name

func (p *Project) Name() string

func (*Project) Publication

func (p *Project) Publication() *Publication

func (*Project) RequestRoles

func (p *Project) RequestRoles() []workspace.Role

func (*Project) SetImageURL

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

func (*Project) SetPublication

func (p *Project) SetPublication(publication *Publication)

func (*Project) SetRequestRoles

func (p *Project) SetRequestRoles(sr []workspace.Role)

func (*Project) SetUpdatedAt

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

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) UpdateTeam

func (p *Project) UpdateTeam(team accountdomain.WorkspaceID)

func (*Project) UpdatedAt

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

func (*Project) Workspace

func (p *Project) Workspace() accountdomain.WorkspaceID

type Publication

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

func NewPublication

func NewPublication(scope PublicationScope, assetPublic bool) *Publication

func NewPublicationWithToken

func NewPublicationWithToken(scope PublicationScope, assetPublic bool, token string) *Publication

func (*Publication) AssetPublic

func (p *Publication) AssetPublic() bool

func (*Publication) Clone

func (p *Publication) Clone() *Publication

func (*Publication) GenerateToken

func (p *Publication) GenerateToken()

func (*Publication) Scope

func (p *Publication) Scope() PublicationScope

func (*Publication) SetAssetPublic

func (p *Publication) SetAssetPublic(assetPublic bool)

func (*Publication) SetScope

func (p *Publication) SetScope(scope PublicationScope)

func (*Publication) Token

func (p *Publication) Token() string

type PublicationScope

type PublicationScope string

const (
	PublicationScopePrivate PublicationScope = "private"
	PublicationScopeLimited PublicationScope = "limited"
	PublicationScopePublic  PublicationScope = "public"
)

type WorkspaceID

type WorkspaceID = id.WorkspaceID