Class SettingController

Namespace

Oqtane.Controllers

Assembly

Oqtane.Server.dll

[Route("api/[controller]")]
public class SettingController : Controller

Inheritance

object

ControllerBase

Controller

SettingController

Constructors

SettingController(ISettingRepository, IPageModuleRepository, IUserPermissions, ITenantManager, ISyncManager, IAliasAccessor, IOptionsMonitorCache<CookieAuthenticationOptions>, IOptionsMonitorCache<OpenIdConnectOptions>, IOptionsMonitorCache<OAuthOptions>, IOptionsMonitorCache<IdentityOptions>, ILogManager)

public SettingController(ISettingRepository settings, IPageModuleRepository pageModules, IUserPermissions userPermissions, ITenantManager tenantManager, ISyncManager syncManager, IAliasAccessor aliasAccessor, IOptionsMonitorCache<CookieAuthenticationOptions> cookieCache, IOptionsMonitorCache<OpenIdConnectOptions> oidcCache, IOptionsMonitorCache<OAuthOptions> oauthCache, IOptionsMonitorCache<IdentityOptions> identityCache, ILogManager logger)

Parameters

settings ISettingRepository

pageModules IPageModuleRepository

userPermissions IUserPermissions

tenantManager ITenantManager

syncManager ISyncManager

aliasAccessor IAliasAccessor

cookieCache IOptionsMonitorCache<CookieAuthenticationOptions>

oidcCache IOptionsMonitorCache<OpenIdConnectOptions>

oauthCache IOptionsMonitorCache<OAuthOptions>

identityCache IOptionsMonitorCache<IdentityOptions>

logger ILogManager

Methods

Clear()

[HttpDelete("clear")]
[Authorize(Roles = "Administrators")]
public void Clear()

Delete(string, int, string)

[HttpDelete("{entityName}/{entityId}/{settingName}")]
public void Delete(string entityName, int entityId, string settingName)

Parameters

entityName string

entityId int

settingName string

Get(int, string)

[HttpGet("{id}/{entityName}")]
public Setting Get(int id, string entityName)

Parameters

id int

entityName string

Returns

Setting

Get(string, int)

[HttpGet]
public IEnumerable<Setting> Get(string entityName, int entityId)

Parameters

entityName string

entityId int

Returns

IEnumerable<Setting>

Post(Setting)

[HttpPost]
public Setting Post(Setting setting)

Parameters

setting Setting

Returns

Setting

Put(int, Setting)

[HttpPut("{id}")]
public Setting Put(int id, Setting setting)

Parameters

id int

setting Setting

Returns

Setting

Put(string, int, string, string, bool)

[HttpPut("{entityName}/{entityId}/{settingName}/{settingValue}/{isPrivate}")]
public void Put(string entityName, int entityId, string settingName, string settingValue, bool isPrivate)

Parameters

entityName string

entityId int

settingName string

settingValue string

isPrivate bool