user

Documentation

Index

• Variables
• func IsSafeName(name string) bool
• func RandomName(randReader io.Reader, n int) (string, error)
• type Auth
  • func AuthFromOIDCSub(oidcSub string) Auth
• type Builder
  • func New() *Builder
  • func (b *Builder) Auth(auth Auth) *Builder
  • func (b *Builder) Build() (*User, error)
  • func (b *Builder) Description(description string) *Builder
  • func (b *Builder) DisplayName(displayName string) *Builder
  • func (b *Builder) ID(id ID) *Builder
  • func (b *Builder) Lang(lang language.Tag) *Builder
  • func (b *Builder) LangFrom(lang string) *Builder
  • func (b *Builder) Name(name string) *Builder
  • func (b *Builder) NewID() *Builder
  • func (b *Builder) Organizations(organizations []OrganizationID) *Builder
• type ID
• type Organization
  • func (o Organization) Active() bool
  • func (o Organization) Description() string
  • func (o Organization) DisplayName() string
  • func (o Organization) ID() OrganizationID
  • func (o Organization) Name() string
• type OrganizationBuilder
  • func NewOrganization() *OrganizationBuilder
  • func (b *OrganizationBuilder) Active(active bool) *OrganizationBuilder
  • func (b *OrganizationBuilder) Build() *Organization
  • func (b *OrganizationBuilder) Description(description string) *OrganizationBuilder
  • func (b *OrganizationBuilder) DisplayName(displayName string) *OrganizationBuilder
  • func (b *OrganizationBuilder) ID(id OrganizationID) *OrganizationBuilder
  • func (b *OrganizationBuilder) Name(name string) *OrganizationBuilder
  • func (b *OrganizationBuilder) NewID() *OrganizationBuilder
• type OrganizationID
• type OrganizationIDs
• type User
  • func (u *User) AddOrganization(organizationID OrganizationID)
  • func (u *User) Auth() Auth
  • func (u *User) Description() string
  • func (u *User) DisplayName() string
  • func (u *User) ID() ID
  • func (u *User) IDRef() *ID
  • func (u *User) Lang() language.Tag
  • func (u *User) Name() string
  • func (u *User) Organizations() OrganizationIDs
  • func (u *User) SetDescription(description string)
  • func (u *User) SetDisplayName(displayName string)
  • func (u *User) SetLang(lang language.Tag)
  • func (u *User) SetName(name string)

Variables

var ErrInvalidID = id.ErrInvalidID

var NewID = id.NewUserID

var NewOrganizationID = id.NewOrganizationID

Functions

func IsSafeName

func IsSafeName(name string) bool

func RandomName

func RandomName(randReader io.Reader, n int) (string, error)

Types

type Auth

type Auth struct {
	Provider string
	Sub      string
}

func AuthFromOIDCSub

func AuthFromOIDCSub(oidcSub string) Auth

type Builder

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

func New

func New() *Builder

func (*Builder) Auth

func (b *Builder) Auth(auth Auth) *Builder

func (*Builder) Build

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

func (*Builder) Description

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

func (*Builder) DisplayName

func (b *Builder) DisplayName(displayName string) *Builder

func (*Builder) ID

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

func (*Builder) Lang

func (b *Builder) Lang(lang language.Tag) *Builder

func (*Builder) LangFrom

func (b *Builder) LangFrom(lang string) *Builder

func (*Builder) Name

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

func (*Builder) NewID

func (b *Builder) NewID() *Builder

func (*Builder) Organizations

func (b *Builder) Organizations(organizations []OrganizationID) *Builder

type ID

type ID = id.UserID

type Organization

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

func (Organization) Active

func (o Organization) Active() bool

func (Organization) Description

func (o Organization) Description() string

func (Organization) DisplayName

func (o Organization) DisplayName() string

func (Organization) ID

func (o Organization) ID() OrganizationID

func (Organization) Name

func (o Organization) Name() string

type OrganizationBuilder

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

func NewOrganization

func NewOrganization() *OrganizationBuilder

func (*OrganizationBuilder) Active

func (b *OrganizationBuilder) Active(active bool) *OrganizationBuilder

func (*OrganizationBuilder) Build

func (b *OrganizationBuilder) Build() *Organization

func (*OrganizationBuilder) Description

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

func (*OrganizationBuilder) DisplayName

func (b *OrganizationBuilder) DisplayName(displayName string) *OrganizationBuilder

func (*OrganizationBuilder) ID

func (b *OrganizationBuilder) ID(id OrganizationID) *OrganizationBuilder

func (*OrganizationBuilder) Name

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

func (*OrganizationBuilder) NewID

func (b *OrganizationBuilder) NewID() *OrganizationBuilder

type OrganizationID

type OrganizationID = id.OrganizationID

type OrganizationIDs

type OrganizationIDs = id.OrganizationIDList

type User

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

func (*User) AddOrganization

func (u *User) AddOrganization(organizationID OrganizationID)

func (*User) Auth

func (u *User) Auth() Auth

func (*User) Description

func (u *User) Description() string

func (*User) DisplayName

func (u *User) DisplayName() string

func (*User) ID

func (u *User) ID() ID

func (*User) IDRef

func (u *User) IDRef() *ID

func (*User) Lang

func (u *User) Lang() language.Tag

func (*User) Name

func (u *User) Name() string

func (*User) Organizations

func (u *User) Organizations() OrganizationIDs

func (*User) SetDescription

func (u *User) SetDescription(description string)

func (*User) SetDisplayName

func (u *User) SetDisplayName(displayName string)

func (*User) SetLang

func (u *User) SetLang(lang language.Tag)

func (*User) SetName

func (u *User) SetName(name string)