Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

users

package

Go to main page

Versions in this module

v2

v2.4.8

Nov 14, 2022

v2.4.5

Nov 3, 2022

v2.4.3

Oct 20, 2022

v2.4.0

Sep 21, 2022

Changes in this version

+ type AddressMode int

+ const CombinedMode

+ const SplitMode

+ func (mode AddressMode) String() string

+ type UserInfo struct

+ Addresses []string

+ Connected bool

+ ID string

+ Mode AddressMode

+ Password string

+ Primary int

+ TotalBytes int64

+ UsedBytes int64

+ Username string

type Users

+ func (u *Users) GetUserIDs() []string

+ func (u *Users) GetUserInfo(userID string) (UserInfo, error)

+ func (u *Users) LogoutUser(userID string) error

+ func (u *Users) SetAddressMode(userID string, mode AddressMode) error

v2.3.0

Aug 31, 2022

v2.2.2

Jul 26, 2022

v2.2.1

Jul 14, 2022

Changes in this version

+ var ErrLoggedOutUser = errors.New("account is logged out, use the app to login again")

+ var ErrUserAlreadyConnected = errors.New("user is already connected")

+ var ErrWrongMailboxPassword = errors.New("wrong mailbox password")

+ type CredentialsStorer interface

+ Add func(userID, userName, uid, ref string, mailboxPassword []byte, emails []string) (*credentials.Credentials, error)

+ Delete func(userID string) error

+ Get func(userID string) (*credentials.Credentials, error)

+ List func() (userIDs []string, err error)

+ Logout func(userID string) (*credentials.Credentials, error)

+ SwitchAddressMode func(userID string) (*credentials.Credentials, error)

+ UpdateEmails func(userID string, emails []string) (*credentials.Credentials, error)

+ UpdatePassword func(userID string, password []byte) (*credentials.Credentials, error)

+ UpdateToken func(userID, uid, ref string) (*credentials.Credentials, error)

+ type Locator interface

+ Clear func() error

+ type PanicHandler interface

+ HandlePanic func()

+ type StoreMaker interface

+ New func(user store.BridgeUser) (*store.Store, error)

+ Remove func(userID string) error

+ type User struct

+ func (u *User) CheckBridgeLogin(password string) error

+ func (u *User) CloseAllConnections()

+ func (u *User) CloseConnection(address string)

+ func (u *User) GetAddressID(address string) (id string, err error)

+ func (u *User) GetAddresses() []string

+ func (u *User) GetBridgePassword() string

+ func (u *User) GetClient() pmapi.Client

+ func (u *User) GetPrimaryAddress() string

+ func (u *User) GetStore() *store.Store

+ func (u *User) GetStoreAddresses() []string

+ func (u *User) ID() string

+ func (u *User) IsCombinedAddressMode() bool

+ func (u *User) IsConnected() bool

+ func (u *User) Logout() error

+ func (u *User) SwitchAddressMode() error

+ func (u *User) TotalBytes() int64

+ func (u *User) UpdateSpace(apiUser *pmapi.User)

+ func (u *User) UpdateUser(ctx context.Context) error

+ func (u *User) UsedBytes() int64

+ func (u *User) Username() string

+ type Users struct

+ func New(locations Locator, panicHandler PanicHandler, eventListener listener.Listener, ...) *Users

+ func (u *Users) ClearData() error

+ func (u *Users) ClearUsers() error

+ func (u *Users) DeleteUser(userID string, clearStore bool) error

+ func (u *Users) DisableCache() error

+ func (u *Users) EnableCache() error

+ func (u *Users) FinishLogin(client pmapi.Client, auth *pmapi.Auth, password []byte) (user *User, err error)

+ func (u *Users) GetUser(query string) (*User, error)

+ func (u *Users) GetUsers() []*User

+ func (u *Users) Login(username string, password []byte) (authClient pmapi.Client, auth *pmapi.Auth, err error)

+ func (u *Users) MigrateCache(srcPath, dstPath string) error

+ func (u *Users) SendMetric(m metrics.Metric) error

Other modules containing this package

github.com/ProtonMail/proton-bridge