Global

Members

AddFieldOptions

Specifies the control settings while adding a field.
Source:

AddFieldOptions[undefined]

Specify that a new field that is added to the specified list must also be added to all content types in the site collection
Source:

AddFieldOptions[undefined]

Specify adding an internal field name hint for the purpose of avoiding possible database locking or field renaming operations
Source:

AddFieldOptions[undefined]

Specify that a new field added to the list must also be added to the default content type in the site collection.
Source:

AddFieldOptions[undefined]

Specify that a new field must not be added to any other content type
Source:

AddFieldOptions[undefined]

Specify that a new field that is added to the specified list must also be added to the default list view
Source:

AddFieldOptions[undefined]

Specify to confirm that no other field has the same display name
Source:

AddFieldOptions[undefined]

Specify that a new field added to the list must also be added to the default content type in the site collection
Source:

AttachmentFile

Describes a single attachment file instance
Source:

AttachmentFiles

Describes a collection of Item objects
Source:

CachingConfigurationProvider

A caching provider which can wrap other non-caching providers
Source:

config

Global configuration instance to which providers can be added
Source:

config

Global configuration instance to which providers can be added
Source:

ConsoleListener

Implementation of ILogListener which logs to the browser console
Source:

ContentType

Describes a single ContentType instance
Source:

ContentTypes

Describes a collection of content types
Source:

ControlMode

Determines the display mode of the given control or view
Source:

CurrentUser

Represents the current user
Source:

default

Enables use of the import pnp from syntax
Source:

default

Enables use of the import pnp from syntax
Source:

Dictionary

Generic dictionary
Source:

Features

Describes a collection of List objects
Source:

FetchClient

Makes requests using the fetch API
Source:

Field

Describes a single of Field instance
Source:
Represents a field link instance
Source:
Represents a collection of field link instances
Source:

Fields

Describes a collection of Field objects
Source:

FieldTypes

Specifies the type of the field.
Source:

File

Describes a single File instance
Source:

Files

Describes a collection of File objects
Source:

Folder

Describes a single Folder instance
Source:

Folders

Describes a collection of Folder objects
Source:

Form

Describes a single of Form instance
Source:

Forms

Describes a collection of Field objects
Source:

FunctionListener

Implementation of ILogListener which logs to the supplied function
Source:

Item

Descrines a single Item instance
Source:

Items

Describes a collection of Item objects
Source:

List

Describes a single List instance
Source:

Lists

Describes a collection of List objects
Source:

log

Global logging instance to which subscribers can be registered and messages written
Source:

log

Global logging instance to which subscribers can be registered and messages written
Source:

Logger

Class used to subscribe ILogListener and log messages throughout an application
Source:

LogLevel

A set of logging levels
Source:
Exposes the navigation components
Source:
Represents a collection of navigation nodes
Source:

NodeFetchClient

This module is substituted for the NodeFetchClient.ts during the packaging process. This helps to reduce the pnp.js file size by not including all of the node dependencies
Source:

NodeFetchClient

Fetch client for use within nodejs, requires you register a client id and secret with app only permissions
Source:

ODataBatch

Manages a batch of OData operations
Source:

PagedItemCollection

Provides paging functionality for list items
Source:

PipelineMethods

Contains the methods used within the request pipeline
Source:

PnPClientStorage

A class that will establish wrappers for both local and session storage
Source:

PnPClientStorageWrapper

A wrapper class to provide a consistent interface to browser based storage
Source:

PrincipalType

Principal Type enum
Source:

ProcessHttpClientResponseException

Represents an exception with an HttpClient request
Source:

Queryable

Queryable Base Class
Source:

QueryableCollection

Represents a REST collection which can be filtered, paged, and selected
Source:

QueryableInstance

Represents an instance that can be selected
Source:

QueryPropertyValueType

Specifies the type value for the property
Source:

ReorderingRuleMatchType

defines the ReorderingRuleMatchType enum
Source:

Rest

Root of the SharePoint REST module
Source:

RoleAssignments

Describes a set of role assignments for the current scope
Source:
Describes the search API
Source:

SearchResult

Describes the SearchResult class
Source:

SearchResults

Describes the SearchResults class, which returns the formatted and raw version of the query response
Source:

Settings

Class used to manage the current application settings
Source:

setup

Allows for the configuration of the library
Source:

setup

Allows for the configuration of the library
Source:

Site

Describes a site collection
Source:

SiteGroup

Describes a single group
Source:

SiteGroups

Describes a collection of site users
Source:

SiteUser

Describes a single user
Source:

SiteUsers

Describes a collection of all site collection users
Source:

SortDirection

defines the SortDirection enum
Source:

sp

Provides access to the REST interface
Source:

sp

Provides access to the REST interface
Source:

SPListConfigurationProvider

A configuration provider which loads configuration values from a SharePoint list
Source:

SPRequestExecutorClient

Makes requests using the SP.RequestExecutor library.
Source:

storage

Provides access to local and session storage
Source:

storage

Provides access to local and session storage
Source:

Subscription

Describes a single webhook subscription instance
Source:

Subscriptions

Describes a collection of webhook subscriptions
Source:

util

Utility methods
Source:

util

Utility methods
Source:

Version

Describes a single Version instance
Source:

Versions

Describes a collection of Version objects
Source:

View

Describes a single View instance
Source:

Views

Describes the views available in the current context
Source:

Web

Describes a web
Source:

Methods

get()

Gets the forms in this list
Source:

get()

Get's the groups for this user.
Source:

get() → {string}

Gets the title of the SharePoint list, which contains the configuration settings
Source:
Returns:
List title
Type
string

get()

Get's the users for this group
Source:

get()

Gets the current subscriber count
Source:

get()

Get all custom actions on a site collection
Source:

get()

Gets the active features for this site
Source:

get()

Gets the root web of the site collection
Source:

get()

Get the role definition bindings for this role assignment
Source:

get()

Access to user profile methods
Source:

get()

Begins a web scoped REST request
Source:

get()

Begins a site collection scoped REST request
Source:

get()

The URL of the edit profile page for the current user.
Source:

get()

A Boolean value that indicates whether the current user's People I'm Following list is public.
Source:

get()

Gets the closest securable up the security hierarchy whose permissions are applied to this list item
Source:

get()

Gets the set of role assignments for this item
Source:

get()

Provides access to the query builder for this url
Source:

get()

Gets the parent url used when creating this instance
Source:

get()

Gets the people who are following the current user.
Source:

get()

Gets user properties for the current user.
Source:

get()

Indicates if the current query has a batch associated
Source:

get()

Gets a value that specifies the content type order.
Source:

get()

Gets the most popular tags.
Source:

get()

Gets this folder's server relative url
Source:

get()

Gets this folder's properties
Source:

get()

Gets the top bar navigation navigation for the current context
Source:

get()

Gets the quicklaunch navigation for the current context
Source:

get()

Gets the custom list templates for the site.
Source:

get()

Gets the user profile of the site owner.
Source:

get()

Gets the user profile that corresponds to the current user.
Source:

get()

Gets the column (also known as field) references in the content type.
Source:

get()

Gets a value that specifies the collection of fields for the content type.
Source:

get()

Gets the parent content type of the content type.
Source:

get()

Gets the user profile of the site owner.
Source:

get()

Gets the user profile that corresponds to the current user.
Source:

get()

Gets the parent folder, if available
Source:

get()

Gets a value that specifies the collection of workflow associations for the content type.
Source:

get()

Gets a value that specifies the list item field values for the list item corresponding to the file.
Source:

get()

Gets a collection of versions
Source:

get()

Gets the webhook subscriptions of this list
Source:

get()

Gets the IRM settings for this list
Source:

get()

Gets the related fields of this list
Source:

get()

Gets the event receivers attached to this list
Source:

get()

Gets the effective base permissions of this list
Source:

get()

Get all custom actions on a site collection
Source:

get()

Gets the default view of this list
Source:

get() → {string}

Gets the url of the SharePoint site, where the configuration list is located
Source:
Returns:
Url address of the site
Type
string

get()

Gets the fields in this list
Source:

get()

Gets the views in this list
Source:

get()

Gets the items in this list
Source:

get()

Gets the set of web part definitions contained by this web part manager
Source:

get()

Gets the content types in this list
Source:

get()

Gets this folder's list item field values
Source:

get()

Gets the set of attachments for this item
Source:

get()

Gets the webpart information associated with this definition
Source:

get()

If true there are more results available in the set, otherwise there are not
Source:

get()

Specifies the sequence in which content types are displayed.
Source:

get()

Gets this folder's files
Source:

get()

Get the content types available in this web
Source:

get()

Get the lists in this web
Source:

get()

Gets the fields in this web
Source:

get()

Gets the active features for this web
Source:

get()

Gets the available fields in this web
Source:

get()

Get the navigation options in this web
Source:

get()

Gets the site users
Source:

get()

Gets the site groups
Source:

get()

Gets the current user
Source:

get()

Get the folders in this web
Source:

get()

Get all custom actions on a site
Source:

get()

Gets the collection of RoleDefinition resources.
Source:

get()

Gets this folder's sub folders
Source:

get()

Gets the folder associated with this list item (if this item represents a folder)
Source:

get()

Gets the folder associated with this list item (if this item represents a folder)
Source:

get()

Gets the field values for this list item for use in editing controls
Source:

get()

Gets the field values for this list item in their text representation
Source:

get()

Gets the field values for this list item in their HTML representation
Source:

get()

Gets the effective base permissions for the item in a UI context
Source:

get()

Gets the effective base permissions for the item
Source:

get()

Gets the content type for this item
Source:

get()

Represents the child nodes of this node
Source:

pipe(context)

Processes a given context through the request pipeline
Parameters:
Name Type Description
context The request context we are processing
Source:

readBlobAs(blob, mode)

Generic method to read blob's content
Parameters:
Name Type Description
blob The data to read
mode The read mode
Source:

readBlobAsArrayBuffer(blob)

Reads a blob into an array buffer
Parameters:
Name Type Description
blob The data to read
Source:

readBlobAsText(blob)

Reads a blob as text
Parameters:
Name Type Description
blob The data to read
Source:

requestPipelineMethod()

decorator factory applied to methods in the pipeline to control behavior
Source: