user

Documentation

Overview

Package user provides the /users APIs

Index

• Constants
• func ListEvents(ctx context.Context, params *trimmer.EventListParams) *event.Iter
• func ListMedia(ctx context.Context, params *trimmer.MediaListParams) *media.Iter
• func ListOrgs(ctx context.Context, params *trimmer.OrgListParams) *org.Iter
• func ListVolumes(ctx context.Context, params *trimmer.VolumeListParams) *volume.Iter
• func ListWorkspaces(ctx context.Context, params *trimmer.WorkspaceListParams) *workspace.Iter
• func Lookup(ctx context.Context, params *trimmer.UserLookupParams) (trimmer.UserList, error)
• func Me(ctx context.Context, params *trimmer.UserParams) (*trimmer.User, error)
• func NewVolume(ctx context.Context, params *trimmer.VolumeParams) (*trimmer.Volume, error)
• func NewWorkspace(ctx context.Context, params *trimmer.WorkspaceParams) (*trimmer.Workspace, error)
• func UpdateMe(ctx context.Context, params *trimmer.UserParams) (*trimmer.User, error)
• func UploadImage(ctx context.Context, params *trimmer.FileInfo, src io.Reader) (*trimmer.Media, error)
• type Client
  • func (c Client) ListEvents(ctx context.Context, params *trimmer.EventListParams) *event.Iter
  • func (c Client) ListMedia(ctx context.Context, params *trimmer.MediaListParams) *media.Iter
  • func (c Client) ListOrgs(ctx context.Context, params *trimmer.OrgListParams) *org.Iter
  • func (c Client) ListVolumes(ctx context.Context, params *trimmer.VolumeListParams) *volume.Iter
  • func (c Client) ListWorkspaces(ctx context.Context, params *trimmer.WorkspaceListParams) *workspace.Iter
  • func (c Client) Lookup(ctx context.Context, params *trimmer.UserLookupParams) (trimmer.UserList, error)
  • func (c Client) Me(ctx context.Context, params *trimmer.UserParams) (*trimmer.User, error)
  • func (c Client) NewVolume(ctx context.Context, params *trimmer.VolumeParams) (*trimmer.Volume, error)
  • func (c Client) NewWorkspace(ctx context.Context, params *trimmer.WorkspaceParams) (*trimmer.Workspace, error)
  • func (c Client) Search(ctx context.Context, params *trimmer.UserSearchParams) *Iter
  • func (c Client) UpdateMe(ctx context.Context, params *trimmer.UserParams) (*trimmer.User, error)
• type Iter
  • func Search(ctx context.Context, params *trimmer.UserSearchParams) *Iter
  • func (i *Iter) User() *trimmer.User

Constants

const (
	UserStateParked   trimmer.UserState = "parked"
	UserStateCreated  trimmer.UserState = "created"
	UserStateInvited  trimmer.UserState = "invited"
	UserStateActive   trimmer.UserState = "active"
	UserStateInactive trimmer.UserState = "inactive"
	UserStateExpired  trimmer.UserState = "expired"
	UserStateBlocked  trimmer.UserState = "blocked"
	UserStateBanned   trimmer.UserState = "banned"
	UserStateDeleting trimmer.UserState = "deleting"
	UserStateCleaning trimmer.UserState = "cleaning"
	UserStateDeleted  trimmer.UserState = "deleted"
	UserStateRejected trimmer.UserState = "rejected"
)

const (
	UserSearchDefault     trimmer.UserSearchFields = "default"
	UserSearchAll         trimmer.UserSearchFields = "all"
	UserSearchName        trimmer.UserSearchFields = "name"
	UserSearchDisplayName trimmer.UserSearchFields = "displayName"
	UserSearchEmail       trimmer.UserSearchFields = "email"
	UserSearchLocation    trimmer.UserSearchFields = "location"
	UserSearchDescription trimmer.UserSearchFields = "description"
)

Functions

func ListEvents

func ListEvents(ctx context.Context, params *trimmer.EventListParams) *event.Iter

func ListMedia

func ListMedia(ctx context.Context, params *trimmer.MediaListParams) *media.Iter

func ListOrgs

func ListOrgs(ctx context.Context, params *trimmer.OrgListParams) *org.Iter

func ListVolumes

func ListVolumes(ctx context.Context, params *trimmer.VolumeListParams) *volume.Iter

func ListWorkspaces

func ListWorkspaces(ctx context.Context, params *trimmer.WorkspaceListParams) *workspace.Iter

func Lookup

func Lookup(ctx context.Context, params *trimmer.UserLookupParams) (trimmer.UserList, error)

func Me

func Me(ctx context.Context, params *trimmer.UserParams) (*trimmer.User, error)

func NewVolume

func NewVolume(ctx context.Context, params *trimmer.VolumeParams) (*trimmer.Volume, error)

func NewWorkspace

func NewWorkspace(ctx context.Context, params *trimmer.WorkspaceParams) (*trimmer.Workspace, error)

func UpdateMe

func UpdateMe(ctx context.Context, params *trimmer.UserParams) (*trimmer.User, error)

func UploadImage

func UploadImage(ctx context.Context, params *trimmer.FileInfo, src io.Reader) (*trimmer.Media, error)

Types

type Client

type Client struct {
	B    trimmer.Backend
	Key  trimmer.ApiKey
	Sess *trimmer.Session
}

Client is used to invoke /users APIs.

func (Client) ListEvents

func (c Client) ListEvents(ctx context.Context, params *trimmer.EventListParams) *event.Iter

func (Client) ListMedia

func (c Client) ListMedia(ctx context.Context, params *trimmer.MediaListParams) *media.Iter

func (Client) ListOrgs

func (c Client) ListOrgs(ctx context.Context, params *trimmer.OrgListParams) *org.Iter

func (Client) ListVolumes

func (c Client) ListVolumes(ctx context.Context, params *trimmer.VolumeListParams) *volume.Iter

func (Client) ListWorkspaces

func (c Client) ListWorkspaces(ctx context.Context, params *trimmer.WorkspaceListParams) *workspace.Iter

func (Client) Lookup

func (c Client) Lookup(ctx context.Context, params *trimmer.UserLookupParams) (trimmer.UserList, error)

func (Client) Me

func (c Client) Me(ctx context.Context, params *trimmer.UserParams) (*trimmer.User, error)

func (Client) NewVolume

func (c Client) NewVolume(ctx context.Context, params *trimmer.VolumeParams) (*trimmer.Volume, error)

func (Client) NewWorkspace

func (c Client) NewWorkspace(ctx context.Context, params *trimmer.WorkspaceParams) (*trimmer.Workspace, error)

func (Client) Search

func (c Client) Search(ctx context.Context, params *trimmer.UserSearchParams) *Iter

func (Client) UpdateMe

func (c Client) UpdateMe(ctx context.Context, params *trimmer.UserParams) (*trimmer.User, error)

type Iter

type Iter struct {
	*trimmer.Iter
}

Iter is an iterator for lists of Users. The embedded Iter carries methods with it; see its documentation for details.

func Search

func Search(ctx context.Context, params *trimmer.UserSearchParams) *Iter

func (*Iter) User

func (i *Iter) User() *trimmer.User

User returns the most recent User visited by a call to Next.