SPUser class

パッケージ:

@microsoft/sp-page-context

このクラスは、主に PageContext クラスで使用されます。 ページにアクセスしている SharePoint ユーザーについてのコンテキスト情報を提供します。

注釈

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

プロパティ

displayName	現在のユーザーの表示名。
email	現在のユーザーのメール アドレス。
firstDayOfWeek	ユーザーの地域の週の最初の曜日の設定を返すか、設定されていない場合は未定義を返します。
isAnonymousGuestUser	現在のユーザーが匿名ゲストであるかどうかを返します。
isExternalGuestUser	現在のユーザーが外部のゲストであるかどうかを返します。
loginName	現在のユーザーのログイン名。
preferUserTimeZone	このブール値は、ユーザーまたは Web のタイム ゾーン設定を使用して現在の時刻を表示する必要があるかどうかを表します。
timeZoneInfo	ユーザーの地域タイムゾーン設定を返すか、設定されていない場合は未定義を返します。

プロパティの詳細

displayName

現在のユーザーの表示名。

readonly displayName: string;

プロパティ値

string

注釈

例: "John Doe"

email

現在のユーザーのメール アドレス。

readonly email: string;

プロパティ値

string

注釈

例: "example@contoso.com"

firstDayOfWeek

注意

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

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

readonly firstDayOfWeek: SPDayOfWeek | undefined;

プロパティ値

SPDayOfWeek | undefined

isAnonymousGuestUser

現在のユーザーが匿名ゲストであるかどうかを返します。

readonly isAnonymousGuestUser: boolean;

プロパティ値

boolean

isExternalGuestUser

現在のユーザーが外部のゲストであるかどうかを返します。

readonly isExternalGuestUser: boolean;

プロパティ値

boolean

loginName

現在のユーザーのログイン名。

readonly loginName: string;

プロパティ値

string

注釈

例: オンプレミス ユーザー: "domain\user"、オンライン ユーザー: "user@domain.com"

preferUserTimeZone

このブール値は、ユーザーまたは Web のタイム ゾーン設定を使用して現在の時刻を表示する必要があるかどうかを表します。

readonly preferUserTimeZone: boolean;

プロパティ値

boolean

timeZoneInfo

注意

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

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

readonly timeZoneInfo: SPTimeZone | undefined;

プロパティ値

SPTimeZone | undefined