<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Dynamicweb.Frontend.Classic.Api.Content</name>
    </assembly>
    <members>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.AreasController">
            <summary>
            Areas endpoint.
            </summary>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.AreasController.GetAll">
             <summary>
             Gets all areas for the Dynamicweb solution.
             </summary>
             <remarks>
             No Authorization header required.
            
             Does not include areas that;
             - are not published
             - does not have read permission
            
             Returns an empty list if no areas are found.
             </remarks>
             <returns>List of <see cref="T:Dynamicweb.Frontend.AreaInfoViewModel"/>.</returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.AreasController.GetById(System.Int32)">
             <summary>
             Gets the area by the specified ID.
             </summary>
             <remarks>
             No Authorization header required.
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.AreaInfoViewModel"/>s and their IDs, refer to GET /dwapi/content/areas.
             </remarks>
             <param name="id">The ID identifying a specific area.</param>
             <returns>Instance of <see cref="T:Dynamicweb.Frontend.AreaInfoViewModel"/>, if found; otherwise <c>null</c>.</returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.AreasController.GetByDomain(System.String)">
             <summary>
             Gets all areas associated to the given domain.
             </summary>
             <remarks>
             No Authorization header required.
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.AreaInfoViewModel"/>s and their <see cref="P:Dynamicweb.Frontend.AreaInfoViewModel.Domains"/>s for the Dynamicweb solution, refer to GET /dwapi/content/areas
             </remarks>
             <param name="domain">The domain to find all the areas for, i.e. www.dynamicweb.com</param>
             <returns>Instance of <see cref="T:Dynamicweb.Frontend.AreaInfoViewModel"/>, if found; otherwise <c>null</c>. The instance contains a list of websites that is valid for a given host name.</returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.FormsController.GetAllForms">
            <summary>
            Gets a list of all forms.
            </summary>
            <remarks>
            No Authorization header required. This endpoint generates a unique token to be used in form submissions.
            </remarks>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.FormsController.GetForm(System.Int32)">
            <summary>
            Gets a specific form by ID
            </summary>
            <remarks>
            No Authorization header required. This endpoint generates a unique token to be used in form submissions.
            </remarks>
            <param name="formId">The ID identifying a specific form.</param>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.FormsController.SubmitForm(System.String,System.Int32,Dynamicweb.Forms.FormSubmitViewModel)">
            <summary>
            Submits a form through the delivery API.
            </summary>
            <remarks>
            No Authorization header required. Use either GET/dwapi/forms or GET/dwapi/forms/{formId} to generate the required X-Form-Token.
            </remarks>
            <param name="formToken">The token generated from the GET request.</param>
            <param name="formId">The ID identifying a specific form.</param>
            <param name="formSubmit">The form details to be submitted.</param>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.FormsController.SubmitWithSettings(System.String,System.Int32,System.Guid,Dynamicweb.Forms.FormSubmitViewModel)">
            <summary>
            Submits a form through the delivery API.
            </summary>
            <remarks>
            No Authorization header required. Use either GET/dwapi/forms or GET/dwapi/forms/{formId} to generate the required X-Form-Token.
            </remarks>
            <param name="formToken">The token generated from the GET request.</param>
            <param name="formId">The ID identifying a specific form.</param>
            <param name="settingId">The setting ID.</param>
            <param name="formSubmit">The form details to be submitted.</param>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.FormsController.GenerateAndSaveFormToken(Microsoft.AspNetCore.Http.HttpResponse)">
            <summary>
            Generates a unique token, saves it in the cache, and returns it in the header to be used by other endpoints.
            </summary>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.GridRowsController">
            <summary>
            Grid row endpoint.
            </summary>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.GridRowsController.GetById(System.Int32,System.Nullable{Dynamicweb.Frontend.Devices.DeviceType})">
             <summary>
             Gets a pages Grid Rows based on the given pageId.
             </summary>
             <remarks>
             No Authorization header required.
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/> and their <see cref="P:Dynamicweb.Frontend.PageInfoViewModel.ID"/>, refer to GET /dwapi/content/pages.
            
             Will return an empty list if there's no <see cref="P:Dynamicweb.Frontend.GridViewModel.Rows"/> on the <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/>.
             </remarks>
             <param name="pageId">The ID specifying a page.</param>
             <param name="device">The device type - one of 'Desktop' (default), 'Mobile', 'Tablet'.</param>
             <returns>A collection of <see cref="T:Dynamicweb.Frontend.GridRowViewModel"/>, if found; otherwise <c>null</c>.</returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.GridRowsController.GetByUrl(System.String,System.String)">
             <summary>
             Gets a pages Grid Rows based on the given url.
             </summary>
             <remarks>
             No Authorization header required.
            
             It will find all the areas for the given <paramref name="hostName"/>, then finds the node for the url given and uses that ID in GET /content/rows/{pageId}.
             </remarks>
             <param name="url">The path for a specific page, i.e. /page/subpage/page</param>
             <param name="hostName">The host name for the website to match with. If none is specified, the host name of the request is used.</param>
             <returns>List of <see cref="T:Dynamicweb.Frontend.GridRowViewModel"/>, if found; otherwise <c>null</c>.</returns>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.NavigationsController">
            <summary>
            Endpoint which handles requests related to navigations.
            </summary>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.NavigationsController.GetById(System.Int32,System.Int32,System.String,Dynamicweb.Frontend.Navigation.NavigationSettings)">
             <summary>
             Gets a navigation for a given area.
             </summary>
             <remarks>
             No Authorization header required.
            
             If both an areaId and a pageId is specified, it will use both to create a navigation context to determine which navigations to return, otherwise only the areaId will be used.
            
             If the parameter <see cref="P:Dynamicweb.Frontend.Navigation.NavigationSettings.StartLevel"/> is higher than 1, a <paramref name="pageId"/> may be required.
             </remarks>
             <param name="areaId">An ID identifying the specific area to get navigations for.</param>
             <param name="pageId">An ID identifying the specific page to get navigations for.</param>
             <param name="groupId">An optional ecommerce group ID to set the active group in the navigation context. When provided, the group and its ancestors will be marked as part of the active path.</param>
             <param name="settings">Settings for the navigation, see <see cref="T:Dynamicweb.Frontend.Navigation.NavigationSettings"/>.</param>
             <returns>An instance of a <see cref="T:Dynamicweb.Frontend.Navigation.NavigationTreeViewModel"/> with the items filtered by settings.</returns>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PagesController">
            <summary>
            Pages endpoint - returns page models without their content. Use PageViews, Paragraphs or GridRow endpoints to retrieve the content.
            </summary>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PagesController.GetAll(Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery)">
             <summary>
             Gets all pages based on the query parameters.
             </summary>
             <remarks>
             No Authorization header required.
            
             Each query parameter can be used by itself, or they can be used together to create a stronger filter.
            
             The order of execution for each filter is the following;
             - Find all pages by their parentId matching <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery.PageId"/>
             - Find all pages on the area given the <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery.AreaId"/> or filters the previously found pages on that <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery.AreaId"/>
             - Find all pages with the given <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery.ItemType"/> or filters the previously found pages on their <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery.ItemType"/>
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.AreaInfoViewModel"/> and their <see cref="P:Dynamicweb.Frontend.AreaInfoViewModel.ID"/>, refer to GET /dwapi/content/areas
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/> and their <see cref="P:Dynamicweb.Frontend.PageInfoViewModel.ID"/>, refer to GET /dwapi/content/pages
             </remarks>
             <returns>List of <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/>.</returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PagesController.GetById(System.Int32)">
             <summary>
             Gets a specific page by the given <paramref name="id"/>.
             </summary>
             <remarks>
             No Authorization header required.
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/> and their <see cref="P:Dynamicweb.Frontend.PageInfoViewModel.ID"/>s, refer to GET /dwapi/content/pages
             </remarks>
             <param name="id">The ID identifying a specific page.</param>
             <returns>Instance of <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/>, if found; otherwise <c>null</c>.</returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PagesController.GetByUrl(System.String,System.String)">
             <summary>
             Gets a specific page by the given <paramref name="url"/>.
             </summary>
             <remarks>
             No Authorization header required.
            
             It will find all the areas for the given <paramref name="hostName"/>, then finds the node for the url given and uses that ID in GET /content/pages/{id}.
             </remarks>
             <param name="url">The path for a specific page, i.e. /page/subpage/page</param>
             <param name="hostName">The host name for the website to match with. If none is specified, the host name of the request is used.</param>
             <returns>Instance of <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/>, if found; otherwise <c>null</c>.</returns>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery">
            <summary>
            Query parameters for GET /pages
            </summary>
        </member>
        <member name="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery.AreaId">
            <summary>
            The ID identifying the specific area to get all page models for.
            </summary>
        </member>
        <member name="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery.PageId">
            <summary>
            The ID identifying the specific page to get all its child page models for.
            </summary>
        </member>
        <member name="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageQuery.ItemType">
            <summary>
            The ItemType of the page models to find.
            </summary>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageViewsController">
            <summary>
            PageView endpoint - returns a page with all its content from paragraphs. Does not return module output.
            </summary>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageViewsController.GetById(System.Int32)">
             <summary>
             Get the full <see cref="T:Dynamicweb.Frontend.PageView"/> with content and items for the specified page id.
             </summary>
             <remarks>
             No Authorization header required.
            
             ID has to be larger than 0, otherwise it will be not found by default.
            
             Firstly checks if a page exists with the given ID.
            
             Then retrieves the instance of the <see cref="T:Dynamicweb.Frontend.PageView"/> for the page.
            
             If a page has restricted access, it may be accessed if provided an Authorization header for a user with proper permissions.
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/> and their <see cref="P:Dynamicweb.Frontend.PageInfoViewModel.ID"/>s, refer to GET /dwapi/content/pages.
             </remarks>
             <param name="id">The ID identifying the page to get all content and items for.</param>
             <returns>Instance of <see cref="T:Dynamicweb.Frontend.PageViewModel"/>, if found; otherwise <c>null</c>.</returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.PageViewsController.GetByUrl(System.String,System.String)">
             <summary>
             Get the full <see cref="T:Dynamicweb.Frontend.PageView"/> with content and items for the specified url and host.
             </summary>
             <remarks>
             No Authorization header required.
            
             It will find all the areas for the given <paramref name="hostName"/>, then finds the node for the url given and uses that ID in GET /content/frontend/pageviews/{id}
             </remarks>
             <param name="url">The path of the page, i.e. /page/subpage/page</param>
             <param name="hostName">Specify the host name setup on the website to match with. If none is specified, the request host name is used for lookup.</param>
             <returns>Instance of <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/>, if found; otherwise <c>null</c>.</returns>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphsController">
            <summary>
            Paragraphs endpoint.
            </summary>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphsController.GetAll(Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery)">
             <summary>
             Gets all paragraphs based on the query parameters.
             </summary>
             <remarks>
             No Authorization header required.
            
             Each query parameter can be used by itself, or they can be used together to create a stronger filter.
            
             The order of execution for each filter is the following;
             - Find all pages by their parentId matching <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery.PageId"/>
             - Find all pages on the area given the <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery.AreaId"/> or filters the previously found pages on that <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery.AreaId"/>
             - Find all pages with the given <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery.ItemType"/> or filters the previously found pages on their <see cref="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery.ItemType"/>
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.AreaInfoViewModel"/> and their <see cref="P:Dynamicweb.Frontend.AreaInfoViewModel.ID"/>, refer to GET /dwapi/content/areas.
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/> and their <see cref="P:Dynamicweb.Frontend.PageInfoViewModel.ID"/>, refer to GET /dwapi/content/pages.
            
             Paragraphs returned will always have a <see cref="P:Dynamicweb.Content.Paragraph.ValidFrom"/> later than the request time and <see cref="P:Dynamicweb.Content.Paragraph.ValidTo"/> earlier than the request time, and their <see cref="P:Dynamicweb.Content.Paragraph.ShowParagraph"/> will also be true.
            
             The paragraphs page will have to be both active and published, as well as the pages area has to be active.
            
             If a page has restricted access, it may be accessed if provided an Authorization header for a user with proper permissions.
            
             To get a list of all <see cref="T:Dynamicweb.Frontend.PageInfoViewModel"/> and their <see cref="P:Dynamicweb.Frontend.PageInfoViewModel.ID"/>s, refer to GET /dwapi/content/pages.
             </remarks>
             <param name="query">Specify a valid value for one of the properties to filter what paragraphs to get. If more parameters are specified, the result is combined.</param>
             <returns>List of <see cref="T:Dynamicweb.Frontend.ParagraphInfoViewModel"/>.</returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphsController.GetById(System.Int32)">
             <summary>
             Gets a specific paragraph by the given <paramref name="id"/>.
             </summary>
             <remarks>
             No Authorization header required.
            
             Paragraphs returned will always have a <see cref="P:Dynamicweb.Content.Paragraph.ValidFrom"/> later than the request time and <see cref="P:Dynamicweb.Content.Paragraph.ValidTo"/> earlier than the request time, and their <see cref="P:Dynamicweb.Content.Paragraph.ShowParagraph"/> will also be true.
            
             The paragraphs page will have to be both active and published, as well as the pages area has to be active.
            
             If a page has restricted access, it may be accessed if provided an Authorization header for a user with proper permissions.
             </remarks>
             <param name="id">The ID identifying a specific paragraph.</param>
             <returns>Instance of <see cref="T:Dynamicweb.Frontend.ParagraphInfoViewModel"/>, if found; otherwise <c>null</c>.</returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphsController.GetByUrl(System.String,System.String)">
             <summary>
             Gets a specific paragraph by the given <paramref name="url"/>.
             </summary>
             <remarks>
             No Authorization header required.
            
             It will find all the areas for the given <paramref name="hostName"/>, then finds the node for the url given and uses that ID in GET /content/paragraphs with the found ID as the query parameter.
             </remarks>
             <param name="url">The path for a specific page, i.e. /page/subpage/page</param>
             <param name="hostName">The host name for the website to match with. If none is specified, the host name of the request is used.</param>
             <returns>List of <see cref="T:Dynamicweb.Frontend.ParagraphInfoViewModel"/>, if found; otherwise <c>null</c>.</returns>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery">
            <summary>
            Parameters used to find paragraphs. Only one parameter is needed to be filled out.
            </summary>
        </member>
        <member name="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery.AreaId">
            <summary>
            The ID identifying the specific area to get all paragraphs for.
            </summary>
        </member>
        <member name="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery.PageId">
            <summary>
            The ID identifying the specific page to get all its paragraphs for.
            </summary>
        </member>
        <member name="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.ParagraphQuery.ItemType">
            <summary>
            The ItemType of the paragraphs to find.
            </summary>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.QueriesController">
            <summary>
            Controller for both commands and queries related to query publisher.
            </summary>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.QueriesController.GetAll(Dynamicweb.QueryPublisher.SearchRequest)">
             <summary>
             Gets results based on the query parameters.
             </summary>
             <remarks>
             No Authorization header required.
            
             Will fetch all the results on the DW solution based on the provided query parameters.
             
             **Sample query parameters**
            
             - QueryName=Products
             - RepositoryName=SwiftProducts
             - PageSize=1
             - CurrentPage=1
             
             </remarks>
             <param name="searchRequest">Parameters for the query>.</param>
             <returns>Returns an instance of a <see cref="T:Dynamicweb.QueryPublisher.QueryResultViewModel"/> model.</returns>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.TranslationsController">
            <summary>
            Translations for website labels and texts used in the layout.
            </summary>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.TranslationsController.GetAllByAreaId(System.Int32)">
             <summary>
             Gets all translations for an areas layouts design.
             </summary>
             <remarks>
             No Authorization header required.
            
             Finds the area with the given <paramref name="areaId"/> and uses GET /translations/{designName}/{culture} with the areas layouts designs name and the areas cultureInfos name.
             </remarks>
             <param name="areaId">The ID identifying the area to get the translations for.</param>
             <returns>Translation key collection <see cref="T:Dynamicweb.Rendering.Translation.KeyCollection"/></returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.TranslationsController.GetAllByDesignName(System.String)">
            <summary>
            Gets all translations for a specific design given the designs name.
            </summary>
            <remarks>
            No Authorization header required.
            </remarks>
            <param name="designName">The name of the design to get the translations for.</param>
            <returns>Translation key collection <see cref="T:Dynamicweb.Rendering.Translation.KeyCollection"/></returns>
        </member>
        <member name="M:Dynamicweb.Frontend.Classic.Api.Content.Controllers.TranslationsController.GetAllByDesignNameAndCulture(System.String,System.String)">
            <summary>
            Gets all translations for a design given the designs name and the culture name.
            </summary>
            <remarks>
            No Authorization header required.
            </remarks>
            <returns>List of translations <see cref="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.TranslationsController.Translation"/></returns>
        </member>
        <member name="T:Dynamicweb.Frontend.Classic.Api.Content.Controllers.TranslationsController.Translation">
            <summary>
            Represents a translation of a key and its default fall-back value.
            </summary>
        </member>
        <member name="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.TranslationsController.Translation.Key">
            <summary>
            The translation key.
            </summary>
        </member>
        <member name="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.TranslationsController.Translation.DefaultValue">
            <summary>
            The default value to use if no translation (value) exists.
            </summary>
        </member>
        <member name="P:Dynamicweb.Frontend.Classic.Api.Content.Controllers.TranslationsController.Translation.Value">
            <summary>
            The translation for the culture of the specified key.
            </summary>
        </member>
    </members>
</doc>
