Edit

Share via


@microsoft/sp-page-context package

Page context services for the SharePoint Framework

Classes

AzureActiveDirectoryInfo

This class is primarily used with the PageContext class. It provides information useful for communicating with Azure Active Directory.

CultureInfo

This class is primarily used with the PageContext class. It provides culture info for the current user of the application.

O365GroupAssociation

This class is primarily used with the PageContext class. If the site is associated with an O365 group, this object provides contextual information about the group.

Page

Exposes information that is associated with the SharePoint web page that is currently being displayed.

PageContext

The SharePoint page context object.

SharePointPageContextDataProvider

The page context represents contextual information about the SharePoint page that is currently being viewed, such as its site URL, the client-side application ID, the current user, etc. The page context objects themselves represent key information that is needed e.g. to identify the site/web/list/listitem in a REST service call, but it is not a full cache with invalidation and change notifications.

SPField

A field represents the data model for a column in SharePoint list view.

SPList

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

SPListItem

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

SPPermission

Used to test whether the current user has a requested set of permissions.

SPSite

This class is primarily used with the PageContext class. It provides contextual information for the SharePoint site collection ("SPSite") that hosts the page.

SPTimeZone

It provides timezone information from SharePoint. A conversion from UTC to local time can be calculated by using the following formula.

SPUser

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

SPWeb

This class is primarily used with the PageContext class. It provides contextual information for the SharePoint site ("SPWeb") that hosts the page.

Interfaces

ISPSystemTime

Interface that represents a SPSystemTime structure.

ISPTimeZoneData

Interface that represents the data necessary to build an TimeZone object.

Type Aliases

SPDayOfWeek

The type members represent the seven days of a week.

Enums

O365GroupAssociationType

This enum identifies if the associated O365 Group private or public or unknown.