@azure/msal-react package

Interfaces

IMsalContext

Aliases de tipo

AccountIdentifiers

AuthenticatedTemplateProps

MsalAuthenticationProps

MsalAuthenticationResult

MsalProviderProps

SetComplement

SetDifference

Subtract

UnauthenticatedTemplateProps

WithMsalProps

Funções

AuthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)	Renderiza componentes filho se o usuário for autenticado
MsalAuthenticationTemplate(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 }>)	Tenta autenticar o usuário se ainda não estiver autenticado e renderiza componentes filho
MsalProvider(PropsWithChildren<{ instance: IPublicClientApplication }>)	Componente do provedor de contexto MSAL. Isso deve ser renderizado acima de qualquer outro componente que use MSAL.
UnauthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)	Renderiza componentes filho se o usuário não estiver autenticado
useAccount(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)	Dado 1 ou mais accountIdentifiers, retorna o objeto Account se o usuário estiver conectado
useIsAuthenticated(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)	Retorna se um usuário está conectado ou não no momento. Opcionalmente, forneça 1 ou mais accountIdentifiers para determinar se um usuário específico está conectado
useMsal()	Retorna valores de contexto msal
useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>, Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)	Se um usuário não estiver conectado no momento, esse gancho invocará um logon. Logons com falha podem ser repetidos usando o retorno de chamada de logon retornado. Se um usuário estiver conectado no momento, este gancho tentará adquirir um token. As solicitações de token subsequentes podem usar o retorno de chamada acquireToken retornado. Opcionalmente, forneça um objeto de solicitação a ser usado na chamada login/acquireToken. Opcionalmente, forneça um usuário específico que deve ser conectado.
withMsal<P>(ComponentType<P>)	O componente de ordem superior encapsula o componente fornecido com msal injetando valores de contexto msal nos adereços do componente

Variáveis

MsalConsumer
MsalContext
version

Detalhes da função

AuthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)

Renderiza componentes filho se o usuário for autenticado

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

Parâmetros

props

PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>

Retornos

React.ReactElement | null

MsalAuthenticationTemplate(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 }>)

Tenta autenticar o usuário se ainda não estiver autenticado e renderiza componentes filho

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

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 }>

Retornos

React.ReactElement | null

MsalProvider(PropsWithChildren<{ instance: IPublicClientApplication }>)

Componente do provedor de contexto MSAL. Isso deve ser renderizado acima de qualquer outro componente que use MSAL.

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

Parâmetros

__namedParameters

PropsWithChildren<{ instance: IPublicClientApplication }>

Retornos

React.ReactElement

UnauthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)

Renderiza componentes filho se o usuário não estiver autenticado

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

Parâmetros

props

PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>

Retornos

React.ReactElement | null

useAccount(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)

Dado 1 ou mais accountIdentifiers, retorna o objeto Account se o usuário estiver conectado

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

Parâmetros

accountIdentifiers

Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>

Retornos

AccountInfo | null

useIsAuthenticated(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)

Retorna se um usuário está conectado ou não no momento. Opcionalmente, forneça 1 ou mais accountIdentifiers para determinar se um usuário específico está conectado

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

Parâmetros

matchAccount

Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>

Retornos

boolean

useMsal()

Retorna valores de contexto msal

function useMsal(): IMsalContext

Retornos

IMsalContext

useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>, Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)

Se um usuário não estiver conectado no momento, esse gancho invocará um logon. Logons com falha podem ser repetidos usando o retorno de chamada de logon retornado. Se um usuário estiver conectado no momento, este gancho tentará adquirir um token. As solicitações de token subsequentes podem usar o retorno de chamada acquireToken retornado. Opcionalmente, forneça um objeto de solicitação a ser usado na chamada login/acquireToken. Opcionalmente, forneça um usuário específico que deve ser conectado.

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

interactionType

InteractionType

authenticationRequest

PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>

accountIdentifiers

Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>

Retornos

MsalAuthenticationResult

withMsal<P>(ComponentType<P>)

O componente de ordem superior encapsula o componente fornecido com msal injetando valores de contexto msal nos adereços do componente

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

Parâmetros

Component

ComponentType<P>

Retornos

FunctionComponent<Subtract<P, WithMsalProps>>

Detalhes da variável

MsalConsumer

MsalConsumer: React.Consumer<IMsalContext>

Tipo

React.Consumer<IMsalContext>

MsalContext

MsalContext: React.Context<IMsalContext>

Tipo

React.Context<IMsalContext>

version

version: "3.0.29"

Tipo

"3.0.29"