Interface IQueryWebs

The IQueryWebs interface defines the structure and methods for querying and interacting with SharePoint webs. It extends the RequestBaseQuery interface, which provides common properties for making HTTP requests.

interface IQueryWebs {
    baseUrl: string;
    childrenId?: string;
    clientId: TClientId;
    columnOrder?: number;
    controlOrder?: number;
    endpoint: string;
    itemId?: string;
    listId?: string;
    navItemId?: string;
    pageId?: string;
    partId?: string;
    sectionOrder?: number;
    siteId?: string;
    viewId?: string;
    websId?: string;
    create(props: ICreateWebsProps): Promise<IWebAddResult>;
    delete(): Promise<void>;
    Files(fileId: string): IQueryFiles;
    get(): Promise<void>;
    Lists(listId: string): IQueryLists;
    Navigations(navitemId: string): IQueryNavigations;
    Pages(pageId: string): IQueryPages;
    update(props: IWebInfo): Promise<IWebUpdateResult>;
}

Hierarchy

  • RequestBaseQuery
    • IQueryWebs

Properties

baseUrl childrenId? clientId columnOrder? controlOrder? endpoint itemId? listId? navItemId? pageId? partId? sectionOrder? siteId? viewId? websId?

Methods

create delete Files get Lists Navigations Pages update

Properties

baseUrl

baseUrl: string

The baseUrl:string; is defining a property named baseUrl in the RequestBaseQuery type. The property is of type string and represents the base URL for making requests. It is used as the starting point for constructing the complete URL for the request.

OptionalchildrenId

childrenId?: string

The childrenId?:string|null; line is defining a property named childrenId in the RequestBaseQuery type. The property is optional and can be either a string or null. It represents the ID of a child item or entity and can be used to specify a specific child item or entity within a parent item or entity.

clientId

clientId: TClientId

The line clientId:TClientId; is defining a property named clientId in the RequestBaseQuery type. The property is of type TClientId, which is a type that represents the unique identifier for a client. The actual definition of TClientId is not provided in the code snippet, but it could be a string or a number depending on how it is defined elsewhere in the code.

OptionalcolumnOrder

columnOrder?: number

The columnOrder?:number | null; line is defining a property named columnOrder in the RequestBaseQuery type. The property is optional and can be either a number or null. It represents the order of columns in a table or grid. By including the columnOrder property in the RequestBaseQuery type, it allows for specifying the desired order of columns when making a request or performing CRUD operations related to columns in a table or grid.

OptionalcontrolOrder

controlOrder?: number

The controlOrder?:number | null; line is defining a property named controlOrder in the RequestBaseQuery type. The property is optional and can be either a number or null. It represents the order of controls in a web part. By including the controlOrder property in the RequestBaseQuery type, it allows for specifying the layout and arrangement of controls within a web part when making a request or performing CRUD operations related to controls.

endpoint

endpoint: string

The endpoint:string; line is defining a property named endpoint in the RequestBaseQuery type. The property is of type string and represents the specific endpoint or route that the request should be made to. It is used to specify the specific API endpoint or URL path that the request should be sent to in order to retrieve or manipulate data.

OptionalitemId

itemId?: string

The itemId?:string|null; line is defining a property named itemId in the RequestBaseQuery type. The property is optional and can be either a string or null. It represents the ID of a specific item in a list or collection. By including the itemId property in the RequestBaseQuery type, it allows for specifying a specific item when making a request.

OptionallistId

listId?: string

The listId?:string|null; line is defining a property named listId in the RequestBaseQuery type. The property is optional and can be either a string or null. It represents the ID of a list and can be used to specify a specific list when making a request.

OptionalnavItemId

navItemId?: string

The navItemId?:string|null; line is defining a property named navItemId in the RequestBaseQuery type. The property is optional and can be either a string or null. It represents the ID of a navigation item and can be used to specify the ID of a specific navigation item within a navigation menu or bar.

OptionalpageId

pageId?: string

The pageId?:string|null; line is defining a property named pageId in the RequestBaseQuery type. The property is optional and can be either a string or null. It represents the ID of a page and can be used to specify the ID of a specific page when making a request. Including the pageId property in the RequestBaseQuery type allows for specifying a specific page when performing CRUD operations or retrieving data related to a specific page.

OptionalpartId

partId?: string

The partId?:string; line is defining a property named partId in the RequestBaseQuery type. The property is optional and can be either a string or null. It represents the ID of a web part and is used to uniquely identify a specific web part. Including the partId property in the RequestBaseQuery type allows for specifying a specific web part when making a request or performing CRUD operations related to web parts.

OptionalsectionOrder

sectionOrder?: number

The sectionOrder?:number | null; line is defining a property named sectionOrder in the RequestBaseQuery type. The property is optional and can be either a number or null. It represents the order of sections in a page. It can be used to determine the layout or arrangement of sections on a page. By including the sectionOrder property in the RequestBaseQuery type, it allows for specifying the order of sections when making a request or performing CRUD operations related to sections on a page.

OptionalsiteId

siteId?: string

The siteId?:string|null; line is defining a property named siteId in the RequestBaseQuery type. The property is optional and can be either a string or null. It represents the ID of a site and can be used to specify the site where the requested data or operation should be performed.

OptionalviewId

viewId?: string

The viewId?:string|null; line is defining a property named viewId in the RequestBaseQuery type. The property is optional and can be either a string or null. It represents the ID of a specific view in a list or collection. Views are used to define how data is displayed in a list or collection, such as the columns to show, sorting, filtering, and grouping options. By including the viewId property in the RequestBaseQuery type, it allows for specifying a specific view when making a request.

OptionalwebsId

websId?: string

The websId?:string; line is defining a property named websId in the RequestBaseQuery type. The property is optional and can be either a string or null. It represents the ID of a sub-website and can be used to specify a specific sub-website when making a request or performing CRUD operations related to webs or websites. Including the websId property in the RequestBaseQuery type allows for specifying a specific web or website when needed.

Methods

create

  • create(props): Promise<IWebAddResult>

  • The create property in the IQueryWebs interface represents a function that takes in an object of type ICreateWebsProps as a parameter and returns a promise that resolves to an IWebAddResult.

    Parameters

    Returns Promise<IWebAddResult>

delete

  • delete(): Promise<void>

  • The delete:() => Promise<void>; property in the IQueryWebs interface represents a function that takes no parameters and returns a promise that resolves to void. This function is used to delete the web. When called, it sends a DELETE request to the web's endpoint and returns a promise that resolves when the deletion is successful.

    Returns Promise<void>

Files

  • Files(fileId): IQueryFiles

  • The Files property in the IQueryWebs interface represents a function that takes in a fileId parameter of type string or null and returns an object of type IQueryFiles. This function is used to query and interact with files within the web. The fileId parameter is optional and can be used to specify a specific file to retrieve or update. If no fileId is provided, the function will return a general query object for files within the web.

    Parameters

    • fileId: string

    Returns IQueryFiles

get

  • get(): Promise<void>

  • The get:() => Promise<void>; is a property in the IQueryWebs interface that represents a function that returns a promise. This function is used to retrieve information about the sharepoint's site sub sites. It does not take any parameters and returns a promise that resolves to void.

    Returns Promise<void>

Lists

  • Lists(listId): IQueryLists

  • The Lists property in the IQueryWebs interface represents a function that takes in a listId parameter of type string or null and returns an object of type IQueryLists.

    Parameters

    • listId: string

    Returns IQueryLists

Navigations

  • Navigations(navitemId): IQueryNavigations

  • The Navigations property in the IQueryWebs interface represents a function that takes in a navitemId parameter of type string or null and returns an object of type IQueryNavigations. This function is used to query and interact with navigations within the web. The navitemId parameter is optional and can be used to specify a specific navigation item to retrieve or update. If no navitemId is provided, the function will return a general query object for navigations within the web.

    Parameters

    • navitemId: string

    Returns IQueryNavigations

Pages

  • Pages(pageId): IQueryPages

  • The Pages property in the IQueryWebs interface represents a function that takes in a pageId parameter of type string or null and returns an object of type IQueryPages. This function is used to query and interact with pages within the web.

    Parameters

    • pageId: string

    Returns IQueryPages

update

  • update(props): Promise<IWebUpdateResult>

  • The update property in the IQueryWebs interface represents a function that takes in an object of type IWebInfo as a parameter and returns a promise that resolves to an IWebUpdateResult. This function is used to update the information of a web. The props parameter contains the updated information for the web, such as the title, description, web template, language, and permissions. The function sends a PATCH request to the web's endpoint with the updated information and returns the result of the update operation.

    Parameters

    Returns Promise<IWebUpdateResult>

Settings

Member Visibility

On This Page

Properties
Methods