Function Controls

The Controls function is a TypeScript function that creates an object with methods for getting, creating, updating, and deleting controls.

  • Controls(baseUrl, clientId, siteId, pageId, sectionOrder, columnOrder, controlOrder?): IQueryControls

  • Parameters

    • baseUrl: string

      The base URL for the API endpoint.

    • clientId: TClientId

      The clientId parameter is a unique identifier for the client. It is of type TClientId, which means it can be any valid client ID value.

    • siteId: string

      The siteId parameter represents the unique identifier of the site where the controls are located.

    • pageId: string

      The pageId parameter is a string that represents the unique identifier of a page. It is used to identify the specific page to which the controls belong.

    • sectionOrder: number

      The sectionOrder parameter represents the order of the section in which the control is placed. It is a number that determines the position of the control within the section.

    • columnOrder: number

      The column order parameter represents the order of the column in which the control is placed. It is a number that determines the position of the control within the column.

    • OptionalcontrolOrder: number = null

      The controlOrder parameter is the order or position of the control within its parent column. It is an optional parameter and can be set to null if not needed.

    Returns IQueryControls

    The function Controls returns an object of type IQueryControls.

Settings

Member Visibility