@azure/msal-react package

Renderiza componentes filhos se o utilizador for autenticado

function AuthenticatedTemplate(props: PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>): React.ReactElement | null

Parâmetros

Devoluções

Tenta autenticar o utilizador se ainda não estiver autenticado, depois renderiza componentes filhos

function MsalAuthenticationTemplate(props: PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">> & { authenticationRequest?: PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>, errorComponent?: any, interactionType: InteractionType, loadingComponent?: any }>): React.ReactElement | null

Parâmetros

Devoluções

Componente do fornecedor de contexto MSAL. Isto deve ser renderizado acima de quaisquer outros componentes que utilizem MSAL.

function MsalProvider(__namedParameters: PropsWithChildren<{ instance: IPublicClientApplication }>): React.ReactElement

Parâmetros

Devoluções

Renderiza componentes filhos se o utilizador não for autenticado

function UnauthenticatedTemplate(props: PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>): React.ReactElement | null

Parâmetros

Devoluções

Dado 1 ou mais accountIdentifiers, devolve o objeto Account se o utilizador estiver iniciado em sessão

function useAccount(accountIdentifiers?: Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>): AccountInfo | null

Parâmetros

Devoluções

Devolve independentemente de o utilizador estar ou não atualmente iniciado sessão. Opcionalmente, forneça 1 ou mais accountIdentifiers para determinar se um utilizador específico está iniciado em sessão

function useIsAuthenticated(matchAccount?: Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>): boolean

Parâmetros

Devoluções

Devolve valores de contexto de Msal

function useMsal(): IMsalContext

Devoluções

Se um utilizador não estiver atualmente ligado, este gancho invoca um login. Inicios de sessão falhados podem ser tentados novamente usando o callback de login devolvido. Se um utilizador estiver atualmente ligado, este hook tenta adquirir um token. Pedidos de token subsequentes podem usar o callback acquireToken devolvido. Opcionalmente, forneça um objeto de pedido para ser usado na chamada de login/acquireToken. Opcionalmente, forneça um utilizador específico que deve estar logado.

function useMsalAuthentication(interactionType: InteractionType, authenticationRequest?: PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>, accountIdentifiers?: Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>): MsalAuthenticationResult

Parâmetros

Devoluções

Componentes de ordem superior enrolam o componente com msal ao injetar valores de contexto msal nos props do componente

function withMsal<P>(Component: ComponentType<P>): FunctionComponent<Subtract<P, WithMsalProps>>

Parâmetros

Devoluções

MsalConsumer: React.Consumer<IMsalContext>

Tipo

MsalContext: React.Context<IMsalContext>

Tipo

version: "3.0.29"

Tipo