user package - code.gitea.io/gitea/services/user

Documentation ¶

Index ¶

func AddEmailAddresses(ctx context.Context, u *user_model.User, emails []string) error
func BlockUser(ctx context.Context, doer, blocker, blockee *user_model.User, note string) error
func CanBlockUser(ctx context.Context, doer, blocker, blockee *user_model.User) bool
func CanUnblockUser(ctx context.Context, doer, blocker, blockee *user_model.User) bool
func DeleteAvatar(ctx context.Context, u *user_model.User) error
func DeleteEmailAddresses(ctx context.Context, u *user_model.User, emails []string) error
func DeleteInactiveUsers(ctx context.Context, olderThan time.Duration) error
func DeleteUser(ctx context.Context, u *user_model.User, purge bool) error
func RenameUser(ctx context.Context, u *user_model.User, newUserName string, ...) error
func ReplacePrimaryEmailAddress(ctx context.Context, u *user_model.User, emailStr string) error
func UnblockUser(ctx context.Context, doer, blocker, blockee *user_model.User) error
func UpdateAuth(ctx context.Context, u *user_model.User, opts *UpdateAuthOptions) error
func UpdateOptionFieldFromPtr[T any](value *T) optional.Option[UpdateOptionField[T]]
func UpdateOptionFieldFromSync[T any](value T) optional.Option[UpdateOptionField[T]]
func UpdateOptionFieldFromValue[T any](value T) optional.Option[UpdateOptionField[T]]
func UpdateUser(ctx context.Context, u *user_model.User, opts *UpdateOptions) error
func UploadAvatar(ctx context.Context, u *user_model.User, data []byte) error
type UpdateAuthOptions
type UpdateOptionField
type UpdateOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddEmailAddresses ¶ added in v1.22.0

func AddEmailAddresses(ctx context.Context, u *user_model.User, emails []string) error

func BlockUser ¶ added in v1.22.0

func BlockUser(ctx context.Context, doer, blocker, blockee *user_model.User, note string) error

func CanBlockUser ¶ added in v1.22.0

func CanBlockUser(ctx context.Context, doer, blocker, blockee *user_model.User) bool

func CanUnblockUser ¶ added in v1.22.0

func CanUnblockUser(ctx context.Context, doer, blocker, blockee *user_model.User) bool

func DeleteAvatar ¶

func DeleteAvatar(ctx context.Context, u *user_model.User) error

DeleteAvatar deletes the user's custom avatar.

func DeleteEmailAddresses ¶ added in v1.22.0

func DeleteEmailAddresses(ctx context.Context, u *user_model.User, emails []string) error

func DeleteInactiveUsers ¶

func DeleteInactiveUsers(ctx context.Context, olderThan time.Duration) error

DeleteInactiveUsers deletes all inactive users and their email addresses.

func DeleteUser ¶

func DeleteUser(ctx context.Context, u *user_model.User, purge bool) error

DeleteUser completely and permanently deletes everything of a user, but issues/comments/pulls will be kept and shown as someone has been deleted, unless the user is younger than USER_DELETE_WITH_COMMENTS_MAX_DAYS.

func RenameUser ¶ added in v1.20.0

func RenameUser(ctx context.Context, u *user_model.User, newUserName string, doer *user_model.User) error

RenameUser renames a user

func ReplacePrimaryEmailAddress ¶ added in v1.22.0

func ReplacePrimaryEmailAddress(ctx context.Context, u *user_model.User, emailStr string) error

ReplacePrimaryEmailAddress replaces the user's primary email address with the given email address. It also updates the user's email field to match the new primary email address.

func UnblockUser ¶ added in v1.22.0

func UnblockUser(ctx context.Context, doer, blocker, blockee *user_model.User) error

func UpdateAuth ¶ added in v1.22.0

func UpdateAuth(ctx context.Context, u *user_model.User, opts *UpdateAuthOptions) error

func UpdateOptionFieldFromPtr ¶ added in v1.24.0

func UpdateOptionFieldFromPtr[T any](value *T) optional.Option[UpdateOptionField[T]]

func UpdateOptionFieldFromSync ¶ added in v1.24.0

func UpdateOptionFieldFromSync[T any](value T) optional.Option[UpdateOptionField[T]]

func UpdateOptionFieldFromValue ¶ added in v1.24.0

func UpdateOptionFieldFromValue[T any](value T) optional.Option[UpdateOptionField[T]]

func UpdateUser ¶ added in v1.22.0

func UpdateUser(ctx context.Context, u *user_model.User, opts *UpdateOptions) error

func UploadAvatar ¶

func UploadAvatar(ctx context.Context, u *user_model.User, data []byte) error

UploadAvatar saves custom avatar for user.

Types ¶

type UpdateAuthOptions ¶ added in v1.22.0

type UpdateAuthOptions struct {
	LoginSource        optional.Option[int64]
	LoginName          optional.Option[string]
	Password           optional.Option[string]
	MustChangePassword optional.Option[bool]
	ProhibitLogin      optional.Option[bool]
}

type UpdateOptionField ¶ added in v1.24.0

type UpdateOptionField[T any] struct {
	FieldValue T
	FromSync   bool
}

type UpdateOptions ¶ added in v1.22.0

type UpdateOptions struct {
	KeepEmailPrivate             optional.Option[bool]
	FullName                     optional.Option[string]
	Website                      optional.Option[string]
	Location                     optional.Option[string]
	Description                  optional.Option[string]
	AllowGitHook                 optional.Option[bool]
	AllowImportLocal             optional.Option[bool]
	MaxRepoCreation              optional.Option[int]
	IsRestricted                 optional.Option[bool]
	Visibility                   optional.Option[structs.VisibleType]
	KeepActivityPrivate          optional.Option[bool]
	Language                     optional.Option[string]
	Theme                        optional.Option[string]
	DiffViewStyle                optional.Option[string]
	AllowCreateOrganization      optional.Option[bool]
	IsActive                     optional.Option[bool]
	IsAdmin                      optional.Option[UpdateOptionField[bool]]
	EmailNotificationsPreference optional.Option[string]
	SetLastLogin                 bool
	RepoAdminChangeTeamAccess    optional.Option[bool]
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL