user

Documentation

Index

• type ID
  • func NewID() ID
  • func ParseID(val string) (ID, error)
  • func (val ID) Equals(other interface{}) bool
  • func (val ID) IsEmpty() bool
  • func (val ID) String() string
  • func (val ID) StringPtr() *string
• type User
  • func New(displayname string) *User
  • func NewRaw(idStr string, displayname string) (*User, error)
  • func (u *User) DisplayName() string
  • func (u *User) ID() ID
  • func (u *User) UpdateDisplayName(displayname string)

Types

type ID

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

ID unique user identifier

func NewID

func NewID() ID

NewID generates a new ID

func ParseID

func ParseID(val string) (ID, error)

ParseID creates an ID from a preexisting string value

func (ID) Equals

func (val ID) Equals(other interface{}) bool

Equals determines if two user IDs are equal

func (ID) IsEmpty

func (val ID) IsEmpty() bool

IsEmpty determines if this ID is empty or zero-value

func (ID) String

func (val ID) String() string

String returns the string representation of the ID

func (ID) StringPtr

func (val ID) StringPtr() *string

StringPtr returns a pointer to the string representation of the ID, or nil if it is the zero-value

type User

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

User a user of the scheduled task system

func New

func New(displayname string) *User

New creates a new user entity

func NewRaw

func NewRaw(idStr string, displayname string) (*User, error)

NewRaw instantiates a user entity with all available fields

func (*User) DisplayName

func (u *User) DisplayName() string

DisplayName returns the user's display name

func (*User) ID

func (u *User) ID() ID

ID returns the user's unique ID

func (*User) UpdateDisplayName

func (u *User) UpdateDisplayName(displayname string)

UpdateDisplayName updates the user's display name