SPUser class

包:

@microsoft/sp-page-context

此类主要用于 PageContext 类。 它为访问该页的 SharePoint 用户提供上下文信息。

注解

此类的构造函数标记为内部。 第三方代码不应直接调用构造函数或创建扩展类的 SPUser 子类。

属性

displayName	当前用户的显示名称。
email	当前用户的电子邮件地址。
firstDayOfWeek	返回用户每周第一天的区域设置，如果未设置，则返回未定义。
isAnonymousGuestUser	如果当前用户为匿名来宾，则返回。
isExternalGuestUser	如果当前用户为外部来宾，则返回 true。
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

如果当前用户为外部来宾，则返回 true。

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