Search Results for

    Show / Hide Table of Contents

    Namespace PnP.Core.Model.SharePoint

    Classes

    ACEData

    Represents aceDate part of ACE properties

    ACEFactory

    Default ACE factory

    ACEProperties

    Represents common properties of ACEs

    AdaptiveCardAction

    ACE card action

    AdaptiveCardAction<T>

    ACE card action

    AdaptiveCardControl

    ACE card control

    AdaptiveCardExtension

    Abstract class representing ACE

    AdaptiveCardExtension<T>

    Defines an ACE

    AdaptiveCardTemplate

    ACE template

    AddContentTypeFromHubOptions

    Defines the options that control the adding of content types from the content type hub

    AddUserCustomActionOptions

    Options to specify when adding User Custom Action

    AnalyticsOptions

    Defines what analytics must be retrieved

    AssignedTasksACE

    Assigned tasks ACE

    AssignedTasksACEFactory

    Creates new instance of Assigened Tasks ACE based on provided WebPart

    ButtonAction

    ACE card button action

    CamlQueryOptions

    Options for making a CAML query to SharePoint Online

    CardDesignerACE

    Represents the card designer ACE

    CardDesignerACEFactory

    Creates new instance of CardDesigner ACE based on provided WebPart

    CardDesignerProps

    Card designer ACE properties

    ChangeQueryOptions

    Defines a query that is performed against the change log.

    ChangeTokenOptions

    Represents a change token that is usable in ChangeQueryOptions.

    CommonFieldOptions

    Available options for adding most of SharePoint fields (Excepted Lookup fields)

    ControlFlexLayoutPosition

    Represents the position and dimensions of a control within a flexible layout on a canvas.

    ConvertToOptions

    Defines the options for converting a file to another format

    CopyMigrationOptions

    Optional options that can be passed to the migration job

    CustomImageSettings

    Card icon image settings

    CustomThumbnailOptions

    Options to define a custom thumbnail to retrieve

    DefaultColumnValueOptions

    Holds default column value properties

    DocumentSetContentOptions

    Options for default document set content

    DocumentSetOptions

    Available options for a Document Set

    EventReceiverOptions

    Options that will have to be filled in when creating a new Event Receiver

    ExternalLinkAction

    External link ACE action

    ExternalLinkActionParameter

    External link parameter

    FieldBooleanOptions

    Options for a boolean field

    FieldCalculatedOptions

    Available options for SharePoint Calculated fields

    FieldChoiceMultiOptions

    Available options for SharePoint Multi Choice fields

    FieldChoiceOptions

    Available options for SharePoint Choice fields

    FieldCurrencyOptions

    Available options for SharePoint Currency fields

    FieldDateTimeOptions

    Available options for SharePoint DateTime fields

    FieldLocationValue

    Represents a location field value

    FieldLookupOptions

    Available options for SharePoint lookup fields

    FieldLookupValue

    Represents a lookup field value

    FieldMultilineTextOptions

    Available options for SharePoint Multiline Text fields

    FieldNumberOptions

    Available options for SharePoint Number fields

    FieldTaxonomyOptions

    Options for configuring a Taxonomy field

    FieldTaxonomyValue

    Represents a taxonomy field value

    FieldTextOptions

    Available options for SharePoint Text fields

    FieldThumbnailValue

    Represents a location field value

    FieldUrlOptions

    Available options for SharePoint URL fields

    FieldUrlValue

    Base class for reading and writing of "special" field types like a lookup, user, url...

    FieldUserOptions

    Available options for SharePoint user fields

    FieldUserValue

    Represents a user field value

    FieldValue

    Base class for all field value classes

    FieldValueCollection

    Collection of 'special' field values

    FollowData

    A metadata object following requests

    GenericAdaptiveCardExtension

    Representents a generic, non typed, ACE

    LongRunningOperationOptions

    Defines the options that control the long running operation ILongRunningOperation polling

    MoveCopyOptions

    Options for move and copy operations

    NavigationNodeOptions

    Options to set when creating a new navigation node

    PageImageOptions

    Defines the options to configure an image

    PageTranslationOptions

    Class that defines the languages for which a translation must be generated

    PreviewOptions

    Options that define how the preview URL must be constructed

    QuickView

    Representation of ACE QuickView

    QuickViewAction

    Quick view ACE action

    QuickViewActionParameter

    Quick view ACE action parameters

    RecycleBinQueryOptions

    Defines the recycle bin query criteria

    RenderListDataOptions

    Options to configure the rendering of list data via the RenderListDataAsStream method of IList See https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest#renderlistdataasstream-body-parameter-properties

    SearchOptions

    Defines the search query to make

    SortOption

    Defines a field to be used for sorting search query results

    SyntexModelPublishOptions

    Information about the library to publish a Syntex model to

    SyntexModelUnPublishOptions

    Information about the library to unpublish a Syntex model from

    TeamsACE

    Represents Teams App ACE

    TeamsACEApp

    Teams ACE app

    TeamsACEAppIconProperties

    Teams ACE app icon properties

    TeamsACEFactory

    Creates new instance of TeamsACE based on provided WebPart

    TeamsACEProperties

    Teams ACE Properties

    ThumbnailOptions

    Options to define the file thumbnail retrieval

    UnfurlOptions

    Link unfurling options

    ViewOptions

    Options for creating a view

    WebOptions

    Options to set when creating a new web

    Interfaces

    IActivityActionStat

    Statistics for a given action

    IActivityIncomplete

    Indicates that a resource was generated with incomplete data. The properties within might provide information about why the data is incomplete.

    IActivityStat

    Defines the site/item analytics for a given interval

    IAlert

    SharePoint Alert definition

    IAlertCollection

    Public interface to define a collection of Alert objects

    IAttachment

    A list item attachment

    IAttachmentCollection

    Collection of list item attachments

    IBasePermissions

    Defines the granted permission mask

    IBrandingManager

    Enables branding changes for the site (the options that appear under "change the look" under the gear icon in SharePoint)

    ICanvasColumn

    A column in a ICanvasSection

    ICanvasControl

    Base interface for a canvas control

    ICanvasSection

    Represents a section on the canvas

    IChange

    Base interface for a description of a change to an object.

    IChangeAlert

    Indicates a change to an Alert object.

    IChangeContentType

    Indicates a change to a IContentType object.

    IChangeField

    Indicates a change to a IField object.

    IChangeFile

    Indicates a change to a IFile object.

    IChangeFolder

    Indicates a change to a IFolder object.

    IChangeGroup

    Indicates a change to a ISharePointGroup object.

    IChangeItem

    Indicates a change to a IListItem object;

    IChangeList

    Indicates a change to a IList object.

    IChangeSite

    Indicates a change to a ISite object.

    IChangeToken

    Represents the unique sequential location of a change within the change log.

    IChangeUser

    Indicates a change to a ISharePointUser object.

    IChangeView

    Indicates a change to a IView object.

    IChangeWeb

    Indicates a change to a IWeb object.

    IChromeOptions

    Defines the chrome (header/footer) options of a web

    IComment

    Public interface to define a comment.

    ICommentCollection

    Public interface to define a collection of comment objects.

    ICommentLikeUserEntity

    Represents a single user within a comment's likedBy list in the comments API.

    ICommentLikeUserEntityCollection

    Public interface to define a collection of userEntity objects

    IComplianceTag

    Public interface to define a ComplianceTag / Retention label object of SharePoint Online

    IContentType

    Public interface to define a Content Type object of SharePoint Online

    IContentTypeCollection

    Public interface to define a collection of ContentType objects of SharePoint Online

    IContentTypeHub

    Public interface to define the Content Type Hub object of SharePoint Online

    IContentTypeId

    Public interface to define a Content Type Id object

    IContentTypeIdCollection

    Public interface to define a collection of ContentType objects of SharePoint Online

    IContentTypeInfo

    The contentTypeInfo resource indicates the SharePoint content type of an item.

    ICopyJobProgress

    Represents the progress of a migration job

    ICopyMigrationInfo

    Represents the migration information after creating a migration job

    IDocumentSet

    Public interface to define a Document Set.

    IDocumentSetContent

    Represents the default content of document set in SharePoint.

    IEffectiveInformationRightsManagementSettings

    Public interface to define a EffectiveInformationRightsManagementSettings object

    IEmptySection

    This class is used to instantiate controls of type 1 (= emptySection).

    IEventReceiverDefinition

    Base class that defines general properties of an event receiver for lists and webs

    IEventReceiverDefinitionCollection

    IFeature

    Represents a Feature in SharePoint Online

    IFeatureCollection

    Collection of site or web scoped features

    IField

    Public interface to define a Field object of SharePoint Online

    IFieldCollection

    Public interface to define a collection of Field objects of SharePoint Online

    IFieldLink

    Public interface to define a FieldLink object

    IFieldLinkCollection

    Public interface to define a collection of FieldLink objects of SharePoint Online

    IFieldLocationValue

    Represents a location field value

    IFieldLookupValue

    Represents a lookup field value

    IFieldStringValues

    Public interface to define a FieldStringValues object

    IFieldTaxonomyValue

    Represents a taxonomy field value

    IFieldThumbnailValue

    Represents a image (thumbnail) field value

    IFieldUrlValue

    Represents the value in a field of type Url

    IFieldUserValue

    Represents a user retrieved via a list item field

    IFieldValue

    Represents a field value object

    IFieldValueCollection

    Collection of 'special' field values

    IFile

    Public interface to define a File object

    IFileCollection

    Public interface to define a collection of File objects

    IFilePreview

    Response object from a Graph Preview call on an IFile object Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options. postParameters is a string formatted as application/x-www-form-urlencoded, and if performing a POST to the postUrl the content-type should be set accordingly. For example: POST https://www.onedrive.com/embed_by_post Content-Type: application/x-www-form-urlencoded param1=value&param2=another%20value

    IFileVersion

    Public interface to define a FileVersion object

    IFileVersionCollection

    Collection of file versions

    IFileVersionEvent

    Represents an event object happened on a file

    IFileVersionEventCollection

    Collection of file version events

    IFlowInstance

    Describes a flow instance linked to a library/list

    IFolder

    Public interface to define a Folder object

    IFolderCollection

    Public interface to define a collection of Folder objects

    IFollowing

    An entry point to the social following APIs

    IFollowingInfo

    Represents metadata information about your following data

    IFooterOptions

    Options to configure a the site footer chrome.

    IHeaderOptions

    Options to configure a the site header chrome

    IHubSite

    Public interface to define a HubSite object

    IInformationRightsManagementFileSettings

    Public interface to define a InformationRightsManagementFileSettings object

    IInformationRightsManagementSettings

    Public interface to define a InformationRightsManagementSettings object

    ILikedByInformation

    Defines if and who liked a list item.

    IList

    Public interface to define a List object of SharePoint Online

    IListCollection

    Public interface to define a collection of List objects of SharePoint Online

    IListItem

    Public interface to define a SharePoint Online list item

    IListItemCollection

    Public interface to define a collection of ListItem objects of SharePoint Online

    IListItemVersion

    Public interface to define a ListItemVersion object

    IListItemVersionCollection

    Collection of file versions

    IListSubscription

    Defines a structure for a webhook subscription

    IListSubscriptionCollection

    A collection of list webhook subscriptions

    ILongRunningOperation

    Represents a Microsoft graph async, long running, operation

    IManagedProperty

    Managed property used for search configuration

    INavigation

    Represents the Navigation

    INavigationNode

    Represents the Navigation

    INavigationNodeCollection

    Represents the Navigation

    INavigationOptions

    Options to configure a the site navigation chrome.

    IPage

    A modern SharePoint Page

    IPageComponent

    Client side webpart object (retrieved via the _api/web/GetClientSideWebParts REST call)

    IPageHeader

    Class that implements the modern page header

    IPageText

    Text web part

    IPageTranslationStatus

    Translation status for a page

    IPageTranslationStatusCollection

    Translation status of a page

    IPageWebPart

    This class is used to instantiate modern web parts. Using this class you can instantiate a control and add it on a IPage.

    IPersonProperties

    A metadata for a person

    IPropertyValues

    Public interface to define a PropertyValues object

    IRecycleBinItem

    Public interface to define a RecycleBinItem object

    IRecycleBinItemCollection

    Public interface to define a collection of RecycleBinItem objects

    IRegionalSettings

    Public interface to define a RegionalSettings object

    ISearchRefinementResult

    Search refinement result

    ISearchResult

    Result of search query

    ISecurableObject

    Defines the properties and methods for securable object (Web, List, ListItem)

    ISite

    Public interface to define a Site object of SharePoint Online

    ISocial

    Entry point for the social-related APIs

    ISocialActor

    An entity, which represents a following object. The type of the object can be identified based on the ActorType property

    IStorageMetrics

    Public interface to define a StorageMetrics object

    ISyntexClassifyAndExtractResult

    Result of a classify and extract operation requested for a file

    ISyntexContentCenter

    Syntex Content Center site

    ISyntexModel

    Syntex model

    ISyntexModelPublication

    Defines a model publication

    ISyntexModelPublicationResult

    The result of a SharePoint Syntex model publication

    ITerm

    Represents a term used in a term store. A term can be used to represent an object which can then be used as a metadata to tag conent. Multiple terms can be organized in a hierarchical manner within a set.

    ITermCollection

    Collection of terms

    ITermGroup

    Microsoft 365 Term group

    ITermGroupCollection

    Collection of term groups

    ITermLocalizedDescription

    Represents the localized name used in the term store, which identifies the name in the localized language.

    ITermLocalizedDescriptionCollection

    Collection of localized termset labels

    ITermLocalizedLabel

    Represents the localized label used in the term store, which identifies the name in the localized language.

    ITermLocalizedLabelCollection

    Collection of localized termset labels

    ITermProperty

    Key/Value term property

    ITermPropertyCollection

    Collection of localized termset labels

    ITermRelation

    Represents the relationship between terms in a term store.Currently two types of relationships are supported: pin and reuse.

    In a pin relationship, a term can be pinned under a different term in a different term set.In a pinned relationship, new children to the term can only be added in the term set in which the term was created.Any change in the hierarchy under the term is reflected across the sets in which the term was pinned.

    The reuse relationship is similar to the pinned relationship except that changes to the reused term can be made from any hierarchy in which the term is reused.Also, a change in hierarchy made to the reused term does not get reflected in the other term sets in which the term is reused.

    ITermRelationCollection

    Collection of terms

    ITermSet

    Represents the set used in a term store. The set represents a unit which contains a collection of hierarchical terms. A group can contain multiple sets.

    ITermSetCollection

    Collection of term sets

    ITermSetLocalizedName

    Represents the localized name used in the term store, which identifies the name in the localized language.

    ITermSetLocalizedNameCollection

    Collection of localized termset labels

    ITermSetProperty

    Key/Value term set property

    ITermSetPropertyCollection

    Collection of localized termset labels

    ITermStore

    Microsoft 365 Term store

    ITheme

    Defines a theme that can be applied to a site

    IThumbnail

    A thumbnail for a file in SharePoint, OneDrive or Teams

    ITimeZone

    Public interface to define a TimeZone object

    ITimeZoneCollection

    Public interface to define a collection of TimeZone objects

    IUnfurledResource

    Defines the data coming back from unfurling a link

    IUserCustomAction

    Public interface to define a UserCustomAction object

    IUserCustomActionCollection

    Public interface to define a collection of UserCustomAction objects

    IUserProfile

    An entry point for the user profile APIs

    IView

    Public interface to define a View object

    IViewCollection

    Public interface to define a collection of View objects

    IViewFieldCollection

    View fields model

    IVivaDashboard

    Represents Viva Dashboard page

    IWeb

    Public interface to define a Web object of SharePoint Online

    IWebCollection

    Public interface to define a collection of Web objects of SharePoint Online

    IWebTemplate

    Specifies a site definition or a site template that is used to instantiate a site.

    Enums

    AccessRequestOption

    Operation types for the SetAccessRequest method

    AddFieldOptionsFlags

    Specifies the control settings while adding a field. This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

    AlertDeliveryMethod

    Enumeration of the different delivery methods for alerts

    AlertEventType

    Enumeration of the different types of events for which to receive alerts

    AlertFrequency

    Enumeration of the different frequencies for which to receive alerts

    AlertStatus

    Enumeration of the different statuses of an alert

    AlertType

    Enumeration of the different types of alerts

    AnalyticsAggregationInterval

    Agregation interval for when analytics are retrieved in a custom timewindow

    AnalyticsInterval

    Interval for which to get analytics

    CalendarType

    A calendar type is a 2-byte integer value that specifies the type of calendar to use in a particular context. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee543260%28v%3doffice.15%29

    CanvasSectionTemplate

    The type of canvas being used

    CardSize

    Size of the Adaptive Card Extension (ACE) on the Viva Connections dashboard

    ChangeActivityType

    Change activity types

    ChangeType

    Enumeration of the possible types of changes.

    CheckinType

    Specifies the type of check-in for a file. (see https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee542953(v=office.15) )

    CheckOutType

    Enumeration that describes the different checkout states of a file, independent of the lock state of the file. (e.g. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee538918(v=office.15))

    ChoiceFormatType

    Enumeration that specifies how options are displayed for the selections in a choice field. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee536424%28v%3doffice.15%29

    CommentsDisabledScope

    An enum to determine the scope for which comments are disabled. https://docs.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.comments.commentsdisabledscope?view=sharepoint-csom

    ConvertToFormat

    Target formats for file conversion

    CustomizedPageStatus

    Specifies the cache and customization status for a page.

    DateTimeFieldFormatType

    Specifies the display format for date and time fields. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee537367%28v%3doffice.15%29

    DateTimeFieldFriendlyFormatType

    Specifies a friendly format to use in displaying date and time fields. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/jj168261%28v%3doffice.15%29

    DefaultACE

    List of OOB Adaptive Card Extensions

    DefaultWebPart

    List of possible OOB web parts

    DraftVisibilityType

    Specifies the kind of user who can view the minor version of a document draft.

    EditorType

    Type of editor used for text editing of a page

    EventReceiverSynchronization

    Specifies the synchronization state for the specified event receiver.

    EventReceiverType

    Specifies the type of event that is handled by the event receiver.

    FieldIndexStatus

    Describes whether a field is indexed, and whether the data in the index is complete

    FieldType

    Specifies the type of the field. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee540543(v=office.15)

    FieldUserSelectionMode

    Specifies whether users and groups or only users can be selected. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee545809%28v%3doffice.15%29

    FileLevel

    Publis level of this file

    FileSystemObjectType

    Specifies the file system object type.

    FooterLayoutType

    Available footer layouts for modern sites

    FooterVariantThemeType

    Variants documentation: https://github.com/OfficeDev/office-ui-fabric-react/tree/master/packages/variants Note that this definition is similar to SPVariantThemeType, but with the strong and none variants switched. This is because we want strong to be the default for footer.

    HeaderLayoutType

    Available header layouts for modern sites

    IconAlignment

    Alignment of the collapsible section icon

    ListBaseType

    Specifies the base type for a list.

    ListExperience

    List experience, determines how a list is presented (modern or classic)

    ListPageRenderType

    List Page Render Type. Reasons why the page is rendered in classic UX, or Modern if the page is in Modern UX. (e.g. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/mt796270(v=office.15))

    ListReadingDirection

    Reading direction of the list

    ListTemplateType

    Enumeration to define the list template types for SharePoint

    LogoAlignment

    Logo alignment in extended header layout

    MachineLearningPublicationViewOption

    Options that define how adding a classifier will impact the library's views

    MigrationJobState

    Specifies the state of the migration job

    MoveOperations

    Specifies criteria for how to move files. This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. (see https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee542328(v=office.15) )

    NavigationType

    Navigation type

    PageHeaderLayoutType

    Layout of the page header

    PageHeaderTitleAlignment

    Alignment of the title in a page header

    PageHeaderType

    Types of pages headers that a page can use

    PageImageAlignment

    Image alignment options

    PageLayoutType

    Types of pages that can be created

    PermissionKind

    Index to check if flag for a permission is set or not in SPBasePermissions enumeration

    PromotedState

    Page promotion state

    PublishedStatus

    Indicates if a file was published, draft or checked out

    RecycleBinItemState

    Specifies the Recycle Bin stage of the Recycle Bin item.

    RecycleBinItemType

    Specifies the type of the Recycle Bin item.

    RecycleBinOrderBy

    Specifies the column by which to order a Recycle Bin query.

    RelationshipDeleteBehaviorType

    Specifies the optional relationship behavior of a relationship lookup field. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee537368%28v%3doffice.15%29

    RenderListDataOptionsFlags

    Options to setup on the RenderListDataOptions RenderOptions property See https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest#sprenderlistdataoptions-options

    Role

    This enum class defines a set of abstract roles that a user can be assigned to share a securable object in a document library

    RoleType

    RoleType enumeration used in Role Definitions

    SearchBoxInNavBar

    Searchbox in navigation options

    SearchScope

    Search scopes of the site

    SharePointTheme

    Out of the Box SharePoint themes

    SharingState

    Contains the values of the 3 allowed states for Sharing properties.

    ShowInFiltersPaneStatus

    Represents status to determine whether filters pane will show the field

    SocialActorType

    An actor type in following APIs

    SocialActorTypes

    Represents an actor type, which defines types of following content to return

    SocialFollowResult

    The result of the follow operation

    SocialStatusCode

    A status code of the following item, a property of ISocialActor

    SortDirection

    Sort direction

    SPEffectiveInformationRightsManagementSettingsSource

    The source of settings for the effective IRM of a file. https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/mt684131(v=office.15)

    SPMigrationNameConflictBehavior

    Enum for the behavior when a name conflict occurs

    TemplateFileType

    Types of pages that can be created using the AddTemplateFile method

    TermGroupScope

    Returns type of group. Possible values are 'global', 'system' and 'siteCollection'.

    TermRelationType

    Type of relationship between two terms

    ThumbnailSize

    Standard size of a thumbnail

    UnfurlLinkType

    Defines the type of resource that was provided via the link to unfurl

    UrlFieldFormatType

    Format of the Url field

    UserCustomActionRegistrationType

    Specifies the type of object associated with the custom action.

    UserCustomActionScope

    Specifies the scope of the custom action.

    VariantThemeType

    Footer Variant theme type (see https://github.com/microsoft/fluentui/tree/master/packages/variants)

    ViewScope

    Specifies the recursive scope of a view for a document library.

    ViewType

    Value that specifies the type of the list view.

    ViewType2

    Modern List View Types

    ViewTypeKind

    Value that specifies the type of the list view.

    ZoneReflowStrategy

    Specifies the strategy used to reflow web parts within a zone.

    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer