SPUser class

Pacote:

@microsoft/sp-page-context

Essa classe é usada principalmente com a PageContext classe. Ele fornece informações contextuais para o usuário do SharePoint que acessa a página.

Comentários

O construtor desta classe é marcado como interno. O código de terceiros não deve chamar diretamente o construtor ou criar subclasses que ampliem a classe SPUser.

Propriedades

displayName	O nome de exibição do usuário atual.
email	O endereço de email do usuário atual.
firstDayOfWeek	Retorna a configuração regional do primeiro dia da semana do usuário ou indefinida se ela não tiver sido definida.
isAnonymousGuestUser	Retorna se o usuário atual for um convidado anônimo.
isExternalGuestUser	Retorna true se o usuário atual for um convidado externo.
loginName	O nome de login do usuário atual.
preferUserTimeZone	Esse booliano representa se as configurações de fuso horário do usuário ou da Web devem ser usadas para exibir o horário atual.
timeZoneInfo	Retorna as configurações regionais de fuso horário do usuário ou indefinidas se elas não tiverem sido definidas.

Detalhes da propriedade

displayName

O nome de exibição do usuário atual.

readonly displayName: string;

Valor da propriedade

string

Comentários

Exemplo: "John Doe"

email

O endereço de email do usuário atual.

readonly email: string;

Valor da propriedade

string

Comentários

Exemplo: "example@contoso.com"

firstDayOfWeek

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna a configuração regional do primeiro dia da semana do usuário ou indefinida se ela não tiver sido definida.

readonly firstDayOfWeek: SPDayOfWeek | undefined;

Valor da propriedade

SPDayOfWeek | undefined

isAnonymousGuestUser

Retorna se o usuário atual for um convidado anônimo.

readonly isAnonymousGuestUser: boolean;

Valor da propriedade

boolean

isExternalGuestUser

Retorna true se o usuário atual for um convidado externo.

readonly isExternalGuestUser: boolean;

Valor da propriedade

boolean

loginName

O nome de login do usuário atual.

readonly loginName: string;

Valor da propriedade

string

Comentários

Exemplo: usuário local: "domain\user", usuário online: "user@domain.com"

preferUserTimeZone

Esse booliano representa se as configurações de fuso horário do usuário ou da Web devem ser usadas para exibir o horário atual.

readonly preferUserTimeZone: boolean;

Valor da propriedade

boolean

timeZoneInfo

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna as configurações regionais de fuso horário do usuário ou indefinidas se elas não tiverem sido definidas.

readonly timeZoneInfo: SPTimeZone | undefined;

Valor da propriedade

SPTimeZone | undefined