Documentation
¶
Overview ¶
Package profiles provides access to user profiles and their associated methods
Index ¶
- type InviteParams
- type Profile
- type Profiles
- func (p Profiles) Create(ctx context.Context, email, invitedBy string) (Profile, error)
- func (s Profiles) Get(ctx context.Context, id string) (Profile, error)
- func (s Profiles) Invite(ctx context.Context, p Profile, params InviteParams) error
- func (s Profiles) List(ctx context.Context) ([]Profile, error)
- func (s Profiles) ListFriends(ctx context.Context, profileID string) ([]Profile, error)
- func (s Profiles) Update(ctx context.Context, p Profile, params UpdateProfileParams) (Profile, error)
- type UpdateProfileParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type InviteParams ¶
type Profile ¶
type Profile struct {
ID string
Email string
Name string
Bio string
InvitedBy string
InvitedByName string
Created time.Time
}
Profile represents a user profile
type Profiles ¶
type Profiles struct {
// contains filtered or unexported fields
}
func (Profiles) Invite ¶
Invite creates a provisional profile entry and sends an invite code to the given email address.
func (Profiles) ListFriends ¶
ListFriends returns all complete and active profiles accessible by requester
type UpdateProfileParams ¶
UpdateProfileParams receives optional fields for updating a profile
Click to show internal directories.
Click to hide internal directories.