@azure/msal-react package

Renderuje składniki podrzędne, jeśli użytkownik jest uwierzytelniony

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

Parametry

Zwraca

Próbuje uwierzytelnić użytkownika, jeśli nie został jeszcze uwierzytelniony, renderuje składniki podrzędne

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

Parametry

Zwraca

Składnik dostawcy kontekstu BIBLIOTEKI MSAL. Należy to renderować powyżej innych składników korzystających z biblioteki MSAL.

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

Parametry

Zwraca

Renderuje składniki podrzędne, jeśli użytkownik jest nieuwierzytelniony

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

Parametry

Zwraca

Biorąc pod uwagę co najmniej 1 element accountIdentifiers, zwraca obiekt Account, jeśli użytkownik jest zalogowany

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

Parametry

Zwraca

Zwraca, czy użytkownik jest obecnie zalogowany. Opcjonalnie podaj co najmniej 1 element accountIdentifiers, aby określić, czy określony użytkownik jest zalogowany

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

Parametry

Zwraca

Zwraca wartości kontekstu msal

function useMsal(): IMsalContext

Zwraca

Jeśli użytkownik nie jest obecnie zalogowany, ten punkt zaczepienia wywołuje identyfikator logowania. Nieudane logowania można ponowić przy użyciu zwróconego wywołania zwrotnego logowania. Jeśli użytkownik jest obecnie zalogowany w tym haczyku próbuje uzyskać token. Kolejne żądania tokenu mogą używać zwróconego wywołania zwrotnego acquireToken. Opcjonalnie podaj obiekt żądania, który ma być używany w wywołaniu login/acquireToken. Opcjonalnie podaj określonego użytkownika, który powinien być zalogowany.

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

Parametry

Zwraca

Wyższa kolejność składników zawija składniki z msal przez wstrzyknięcie wartości kontekstu msal do rekwizytów składnika

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

Parametry

Zwraca

MsalConsumer: React.Consumer<IMsalContext>

Typ

MsalContext: React.Context<IMsalContext>

Typ

version: "3.0.29"

Typ