SPWeb class

パッケージ:

@microsoft/sp-page-context

このクラスは、主に PageContext クラスで使用されます。 ページをホストする SharePoint サイト ("SPWeb") のコンテキスト情報が提供されます。

注釈

このクラスのコンストラクターは、内部にマークされています。 サードパーティのコードは、コンストラクターを直接呼び出したり、SPWeb クラスを展開するサブクラスを作成したりすることはできません。

プロパティ

absoluteUrl	この SPWeb の絶対 URL を返します。 例: "https://example.com/sites/PubSite/SubWeb"
description	現在の SPWeb の説明を返します。
firstDayOfWeek	Web の地域の週の最初の曜日の設定を返すか、設定されていない場合は未定義を返します。
id	サーバー上の SPWeb を識別する GUID。
isAppWeb	SPApp のコンテナー Web SPWeb場合は true を返します。
language	Web サイトの既定の言語のロケール識別子 (LCID) を返します。
languageName	Web サイトの既定の言語の言語名を返します。
logoUrl	Web サイトのロゴの絶対 URL を返します。
permissions	現在のユーザーが Web と対話するためのアクセス許可のセットを表す SPPermission オブジェクトを返します。
serverRelativeUrl	この SPWeb のサーバー相対 URL を返します。
templateName	サイトの作成に使用されたサイト定義またはサイト テンプレートの数値識別子を表す文字列を返します。
timeZoneInfo	Web の地域のタイムゾーン設定を返すか、設定されていない場合は未定義を返します。
title	現在の SPWeb のタイトルを返します。

プロパティの詳細

absoluteUrl

この SPWeb の絶対 URL を返します。 例: "https://example.com/sites/PubSite/SubWeb"

readonly absoluteUrl: string;

プロパティ値

string

description

現在の SPWeb の説明を返します。

readonly description: string;

プロパティ値

string

firstDayOfWeek

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

Web の地域の週の最初の曜日の設定を返すか、設定されていない場合は未定義を返します。

readonly firstDayOfWeek: SPDayOfWeek | undefined;

プロパティ値

SPDayOfWeek | undefined

id

サーバー上の SPWeb を識別する GUID。

readonly id: Guid;

プロパティ値

Guid

isAppWeb

SPApp のコンテナー Web SPWeb場合は true を返します。

readonly isAppWeb: boolean;

プロパティ値

boolean

language

Web サイトの既定の言語のロケール識別子 (LCID) を返します。

readonly language: number;

プロパティ値

number

注釈

例: 1033 は en-US のロケール識別子を表します。

languageName

Web サイトの既定の言語の言語名を返します。

readonly languageName: string;

プロパティ値

string

注釈

例: en-US は、米国のロケールの英語を表します。

logoUrl

Web サイトのロゴの絶対 URL を返します。

readonly logoUrl: string;

プロパティ値

string

注釈

例： https://example.com/sites/PubSite/SubWeb/logo.jpg

permissions

現在のユーザーが Web と対話するためのアクセス許可のセットを表す SPPermission オブジェクトを返します。

readonly permissions: SPPermission;

プロパティ値

SPPermission

serverRelativeUrl

この SPWeb のサーバー相対 URL を返します。

readonly serverRelativeUrl: string;

プロパティ値

string

注釈

例: "/sites/PubSite/SubWeb"

templateName

サイトの作成に使用されたサイト定義またはサイト テンプレートの数値識別子を表す文字列を返します。

readonly templateName: string;

プロパティ値

string

注釈

例: "1" は、SharePoint で新しいサイトを作成するときのチーム サイト テンプレートを表します。

timeZoneInfo

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

Web の地域のタイムゾーン設定を返すか、設定されていない場合は未定義を返します。

readonly timeZoneInfo: SPTimeZone | undefined;

プロパティ値

SPTimeZone | undefined

title

現在の SPWeb のタイトルを返します。

readonly title: string;

プロパティ値

string