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, IOptions<CookieAuthenticationOptions>, IOptionsSnapshot<CookieAuthenticationOptions>, IOptionsMonitorCache<CookieAuthenticationOptions>, IOptions<OpenIdConnectOptions>, IOptionsSnapshot<OpenIdConnectOptions>, IOptionsMonitorCache<OpenIdConnectOptions>, IOptions<OAuthOptions>, IOptionsSnapshot<OAuthOptions>, IOptionsMonitorCache<OAuthOptions>, IOptions<IdentityOptions>, IOptionsSnapshot<IdentityOptions>, IOptionsMonitorCache<IdentityOptions>, ILogManager)

public SettingController(ISettingRepository settings, IPageModuleRepository pageModules, IUserPermissions userPermissions, ITenantManager tenantManager, ISyncManager syncManager, IOptions<CookieAuthenticationOptions> cookieOptions, IOptionsSnapshot<CookieAuthenticationOptions> cookieOptionsSnapshot, IOptionsMonitorCache<CookieAuthenticationOptions> cookieOptionsMonitorCache, IOptions<OpenIdConnectOptions> oidcOptions, IOptionsSnapshot<OpenIdConnectOptions> oidcOptionsSnapshot, IOptionsMonitorCache<OpenIdConnectOptions> oidcOptionsMonitorCache, IOptions<OAuthOptions> oauthOptions, IOptionsSnapshot<OAuthOptions> oauthOptionsSnapshot, IOptionsMonitorCache<OAuthOptions> oauthOptionsMonitorCache, IOptions<IdentityOptions> identityOptions, IOptionsSnapshot<IdentityOptions> identityOptionsSnapshot, IOptionsMonitorCache<IdentityOptions> identityOptionsMonitorCache, ILogManager logger)

Parameters

settings ISettingRepository

pageModules IPageModuleRepository

userPermissions IUserPermissions

tenantManager ITenantManager

syncManager ISyncManager

cookieOptions IOptions<CookieAuthenticationOptions>

cookieOptionsSnapshot IOptionsSnapshot<CookieAuthenticationOptions>

cookieOptionsMonitorCache IOptionsMonitorCache<CookieAuthenticationOptions>

oidcOptions IOptions<OpenIdConnectOptions>

oidcOptionsSnapshot IOptionsSnapshot<OpenIdConnectOptions>

oidcOptionsMonitorCache IOptionsMonitorCache<OpenIdConnectOptions>

oauthOptions IOptions<OAuthOptions>

oauthOptionsSnapshot IOptionsSnapshot<OAuthOptions>

oauthOptionsMonitorCache IOptionsMonitorCache<OAuthOptions>

identityOptions IOptions<IdentityOptions>

identityOptionsSnapshot IOptionsSnapshot<IdentityOptions>

identityOptionsMonitorCache IOptionsMonitorCache<IdentityOptions>

logger ILogManager

Methods

Clear()

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

Delete(int, string)

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

Parameters

id int

entityName string

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>

GetEntityIds(string)

[HttpGet("entityids")]
[Authorize(Roles = "Host Users")]
public IEnumerable<int> GetEntityIds(string entityName)

Parameters

entityName string

Returns

IEnumerable<int>

GetEntityNames()

[HttpGet("entitynames")]
[Authorize(Roles = "Host Users")]
public IEnumerable<string> GetEntityNames()

Returns

IEnumerable<string>

Import(Result)

[HttpPost("import")]
[Authorize(Roles = "Host Users")]
public Result Import(Result settings)

Parameters

settings Result

Returns

Result

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