`gws.plugin.account.admin_action`¶

Action for account administration.

Source code: gws.plugin.account.admin_action

Module Contents¶

class gws.plugin.account.admin_action.Config¶

Bases: gws.base.action.Config

Administration of user accounts by account administrators.

models: list[gws.ext.config.model] | None¶: Account data models.

class gws.plugin.account.admin_action.Object¶

Bases: gws.base.action.Object

Account administration action.

Provides the edit API for the helper’s adminModel and the account reset.

h: gws.plugin.account.helper.Object¶: The account helper.

api_delete_feature(req: gws.WebRequester, p: gws.base.edit.api.DeleteFeatureRequest) → gws.base.edit.api.DeleteFeatureResponse¶: Delete an account feature.

api_get_feature(req: gws.WebRequester, p: gws.base.edit.api.GetFeatureRequest) → gws.base.edit.api.GetFeatureResponse¶: Return an account feature.

api_get_features(req: gws.WebRequester, p: gws.base.edit.api.GetFeaturesRequest) → gws.base.edit.api.GetFeaturesResponse¶: Return account features.

api_get_models(req: gws.WebRequester, p: gws.base.edit.api.GetModelsRequest) → gws.base.edit.api.GetModelsResponse¶: Return the account administration model.

api_get_relatable_features(req: gws.WebRequester, p: gws.base.edit.api.GetRelatableFeaturesRequest) → gws.base.edit.api.GetRelatableFeaturesResponse¶: Return features that can be linked to an account.

api_init_feature(req: gws.WebRequester, p: gws.base.edit.api.InitFeatureRequest) → gws.base.edit.api.InitFeatureResponse¶: Return a new account feature with initial values, without saving it.

api_reset(req: gws.WebRequester, p: ResetRequest) → ResetResponse¶: Reset an account.

api_write_feature(req: gws.WebRequester, p: gws.base.edit.api.WriteFeatureRequest) → gws.base.edit.api.WriteFeatureResponse¶: Save an account feature.

configure()¶

class gws.plugin.account.admin_action.Props¶: Bases: gws.base.action.Props

class gws.plugin.account.admin_action.ResetRequest(*args, **kwargs)¶

Bases: gws.Request

Request to reset an account.

featureUid: str¶: Uid of the account feature.

class gws.plugin.account.admin_action.ResetResponse(*args, **kwargs)¶

Bases: gws.Response

Response to an account reset.

feature: gws.FeatureProps¶: The account feature after the reset.