Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IContextInformation

Context Information

Hierarchy

  • IContextInformation

Index

Properties

Methods

Properties

CorrelationId

CorrelationId: string

Correlation ID

DesignPackageId

DesignPackageId: string

Design Package ID

PreviewFeaturesEnabled

PreviewFeaturesEnabled: boolean

Preview Features Enabled

PublishingFeatureOn

PublishingFeatureOn: boolean

Publishing Feature On

RecycleBinItemCount

RecycleBinItemCount: number

Recycle Bin Item Count

aadInstanceUrl

aadInstanceUrl: string

AAD Instance Url

aadTenantId

aadTenantId: string

AAD Tenant Id

alertsEnabled

alertsEnabled: boolean

Alerts Enabled

allowSilverlightPrompt

allowSilverlightPrompt: boolean

Allow Silverlight Prompt

blockDownloadsExperienceEnabled

blockDownloadsExperienceEnabled: boolean

Block Downloads Experience Enabled

canUserCreateMicrosoftForm

canUserCreateMicrosoftForm: boolean

Can User Create Microsoft Form

canUserCreateVisioDrawing

canUserCreateVisioDrawing: boolean

Can User Create Visio Drawing

cdnPrefix

cdnPrefix: string

CDN Prefix

clientServerTimeDelta

clientServerTimeDelta: number

Client Server Time Delta

crossDomainPhotosEnabled

crossDomainPhotosEnabled: boolean

Cross Domain Photos Enabled

currentCultureLCID

currentCultureLCID: string

Current Culture LCID

currentCultureName

currentCultureName: string

Current Culture Name

currentLanguage

currentLanguage: string

Current Language

currentUICultureName

currentUICultureName: string

Current UI Culture Name

departmentId

departmentId: string

Department ID

disableAppViews

disableAppViews: boolean

Disable App Views

disableFlows

disableFlows: boolean

Disable Flows

document

document: HTMLDocument

Document

env

env: string

Environment

existsFl

existsFl: boolean

True if the _spPageContextInfo object exists, flase otherwise.

farmLabel

farmLabel: string

Farm Label

fid

fid: string

FID

formDigestTimeoutSeconds

formDigestTimeoutSeconds: number

Form Digest Timeout Seconds

formDigestValue

formDigestValue: string

Form Digest Value

generateGUID

generateGUID: () => string

Generates a guid.

returns

A GUID as a string value.

Type declaration

    • (): string

    • Returns string

groupColor

groupColor: string

Group Color

groupHasHomepage

groupHasHomepage: boolean

Group Has Homepage

groupId

groupId: string

Group ID

groupType

groupType: string

Group Type

guestsEnabled

guestsEnabled: boolean

Guests Enabled

hasManageWebPermissions

hasManageWebPermissions: boolean

Has Manage Web Permissions

hasPendingWebTemplateExtension

hasPendingWebTemplateExtension: boolean

Has Pending Web Template Extension

hideSyncButtonOnODB

hideSyncButtonOnODB: boolean

Hide Sync Button On ODB

hubSiteId

hubSiteId: boolean

Hub Site ID

idleSessionSignOutEnabled

idleSessionSignOutEnabled: boolean

IDLE Session Sign Out Enabled

isAnonymousGuestUser

isAnonymousGuestUser: boolean

Is Anonymous Guest User

isAppWeb

isAppWeb: boolean

Is App Web

isEmailAuthenticatinoGuesUser

isEmailAuthenticatinoGuesUser: boolean

Is Email Authentication Guest User

isExternalGuestUser

isExternalGuestUser: boolean

Is External Guest User

isHubSite

isHubSite: boolean

Is Hub Site

isMultiGeoTenant

isMultiGeoTenant: boolean

Is Multi Geo Tenant

isNoScriptEnabled

isNoScriptEnabled: boolean

Is No-Script Enabled

isSPO

isSPO: boolean

Is SharePoint Online

isSiteAdmin

isSiteAdmin: boolean

Is Site Administrator

isTenantDevSite

isTenantDevSite: boolean

Is Tenant Development Site

isWebWelcomePage

isWebWelcomePage: boolean

Is Web Welcome Page

layoutsUrl

layoutsUrl: string

Layouts Url

listBaseTemplate

listBaseTemplate: number

List Base Template

listId

listId: string

List Id

listPermMask

listPermMask: BasePermissions

List Permissions Mask

listTitle

listTitle: string

List Title

listUrl

listUrl: string

List Url

maximumFileSize

maximumFileSize: number

Maximum File Size

nid

nid: string

NID

openInClient

openInClient: boolean

Open in Client

pageItemId

pageItemId: number

Page Item Id

pageListId

pageListId: string

Page List Id

pagePermMask

pagePermMask: BasePermissions

Page Permissions Mask

pagePersonalizationScope

pagePersonalizationScope: number

Page Personalization Scope

preferUserTimeZone

preferUserTimeZone: boolean

Prefer User Time Zone

profileUrl

profileUrl: string

Profile Url

serverRedirectedUrl

serverRedirectedUrl: string

Server Redirected Url

serverRequestPath

serverRequestPath: string

Server Request Path

serverTime

serverTime: string

Server Time

showNGSCDialogForSyncOnODB

showNGSCDialogForSyncOnODB: boolean

Show NGSC Dialog for Sync on ODB

showNGSCDialogForSyncOnTS

showNGSCDialogForSyncOnTS: boolean

Show NGSC Dialog for Sync on TS

siteAbsoluteUrl

siteAbsoluteUrl: string

Site Absolute Url

siteClassification

siteClassification: string

Site Classification

siteClientTag

siteClientTag: string

Site Client Tag

siteColor

siteColor: string

Site Color

siteId

siteId: string

Site ID

sitePagesEnabled

sitePagesEnabled: boolean

Site Pages Enabled

siteServerRelativeUrl

siteServerRelativeUrl: string

Site Server Relative Url

siteSubscriptionId

siteSubscriptionId: string

Site Subscription ID

supportPercentStorePage

supportPercentStorePage: boolean

Support Percent Store Page

supportPoundStorePath

supportPoundStorePath: boolean

Support Pound Store Path

systemUserKey

systemUserKey: string

System User Key

tenantAppVersion

tenantAppVersion: string

Tenant App Version

themeCacheToken

themeCacheToken: string

Theme Cache Token

themeCssFolderUrl

themeCssFolderUrl: string

Theme CSS Folder Url

themeImageFileNames

themeImageFileNames: any

Theme Image File Names

updateFromDigestPageLoaded

updateFromDigestPageLoaded: Date

Update From Digest Page Loaded

userDisplayName

userDisplayName: string

User Display Name

userEmail

userEmail: string

User EMail

userFirstDayOfWeek

userFirstDayOfWeek: any

User First Day of Week

userId

userId: number

User Id

userLoginName

userLoginName: string

User Login Name

userTime24

userTime24: boolean

User Time 24

userTimeZoneData

userTimeZoneData: any

User Time Zone Data

viewId

viewId: string

View ID

viewOnlyExperienceEnabled

viewOnlyExperienceEnabled: boolean

View Only Experience Enabled

webAbsoluteUrl

webAbsoluteUrl: string

Web Absolute Url

webDescription

webDescription: string

Web Description

webFirstDayOfWeek

webFirstDayOfWeek: number

Web First Day of Week

webId

webId: string

Web ID

webLanguage

webLanguage: number

Web Language

webLogoUrl

webLogoUrl: string

Web Logo Url

webPermMask

webPermMask: BasePermissions

Web Permissions Mask

webServerRelativeUrl

webServerRelativeUrl: string

Web Server Relative Url

webTemplate

webTemplate: string

Web Template

webTime24

webTime24: boolean

Web Time 24

webTitle

webTitle: string

Web Title

webUIVersion

webUIVersion: number

Web UI Version

window

window: { $REST: any; SP: any; SPClientTemplates: any; addEventListener: any; clearInterval: any; document: HTMLDocument; setInterval: any }

Window

Type declaration

  • $REST: any
  • SP: any
  • SPClientTemplates: any
  • addEventListener: any
  • clearInterval: any
  • document: HTMLDocument
  • setInterval: any

Methods

getWeb

  • getWeb(url: string): IBaseExecution<{ GetContextWebInformation: ContextWebInformation }>

  • Gets the context information of another web. This is required for making POST requests on other site collections.

    Parameters

    • url: string

      The relative url of the web.

    Returns IBaseExecution<{ GetContextWebInformation: ContextWebInformation }>

    The context information of the web.

setPageContext

  • setPageContext(spfxPageContext: any): any

  • Sets the page context information for modern pages.

    Parameters

    • spfxPageContext: any

      The page context information variable from a SPFx project.

    Returns any

Generated using TypeDoc