Table of Contents

Class Sites

Namespace
ToSic.Sxc.DataSources
Assembly
ToSic.Sxc.Cms.dll

Deliver a list of sites from the Oqtane

[PublicApi]
[VisualQuery(ConfigurationType = "", NameId = "a11c28fb-7d8d-40a2-a22c-50beaa019e41", HelpLink = "https://go.2sxc.org/ds-sites", Icon = "public", NiceName = "Sites", Type = DataSourceType.Source, UiHint = "Sites in this system")]
public class Sites : CustomDataSource, IDataSource, IAppIdentity, IZoneIdentity, IAppIdentityLight, ICacheKey, ICacheExpiring, ITimestamped, IHasLog, IDataSourceLinkable, IServiceWithSetup<IDataSourceOptions>
Inheritance
object
Sites
Implements
IServiceWithSetup<IDataSourceOptions>
Inherited Members

Remarks

You can cast the result to ISiteModel for typed use in your code. To figure out the returned properties, best also consult the ISiteModel.

As of now there are no parameters to set.

History

  • Not sure when it was first created, probably early 2023 with the name Roles, and not officially communicated.
  • Model ISiteModel created in v19.01 and officially released

Constructors

Sites(Dependencies, SitesDataSourceProvider)

Deliver a list of sites from the Oqtane

public Sites(CustomDataSource.Dependencies services, SitesDataSourceProvider sitesProvider)

Parameters

services CustomDataSource.Dependencies
sitesProvider SitesDataSourceProvider

Remarks

You can cast the result to ISiteModel for typed use in your code. To figure out the returned properties, best also consult the ISiteModel.

As of now there are no parameters to set.

History

  • Not sure when it was first created, probably early 2023 with the name Roles, and not officially communicated.
  • Model ISiteModel created in v19.01 and officially released

Methods

GetDefault()

Default method called to return data. If the inheriting class overrides this, it can go without having a full constructor.

protected override IEnumerable<IRawData> GetDefault()

Returns

IEnumerable<IRawData>
Edit this page