SPList class

Package:

@microsoft/sp-page-context

This class is primarily used with the PageContext class. It provides contextual information for the SharePoint list that hosts the page.

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SPList class.

Properties

id	The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available.
permissions	Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list.
serverRelativeUrl	Returns the server-relative URL for this SPList.
title	Returns the title for this SPList.

Property Details

id

The GUID that identifies the SPList on the server. This property could be undefined if the information isn't available.

readonly id: Guid;

Property Value

Guid

permissions

Return the SPPermission object that represents the set of permissions that the current user has for interacting with the list.

readonly permissions: SPPermission;

Property Value

SPPermission

serverRelativeUrl

Returns the server-relative URL for this SPList.

readonly serverRelativeUrl: string;

Property Value

string

Remarks

Example: "/sites/PubSite"

title

Returns the title for this SPList.

readonly title: string;

Property Value

string