@azure/msal-react package

Rendert untergeordnete Komponenten, wenn der Benutzer authentifiziert ist

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

Parameter

Gibt zurück

Versucht, den Benutzer zu authentifizieren, wenn er noch nicht authentifiziert ist, und rendert dann untergeordnete Komponenten.

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

Parameter

Gibt zurück

MSAL-Kontextanbieterkomponente. Dies muss über allen anderen Komponenten gerendert werden, die MSAL verwenden.

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

Parameter

Gibt zurück

Rendert untergeordnete Komponenten, wenn der Benutzer nicht authentifiziert ist

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

Parameter

Gibt zurück

Bei 1 oder mehr accountIdentifiers wird das Account-Objekt zurückgegeben, wenn der Benutzer angemeldet ist.

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

Parameter

Gibt zurück

Gibt zurück, ob ein Benutzer aktuell angemeldet ist. Stellen Sie optional 1 oder mehr accountIdentifier bereit, um festzustellen, ob ein bestimmter Benutzer angemeldet ist.

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

Parameter

Gibt zurück

Gibt Msal Context-Werte zurück.

function useMsal(): IMsalContext

Gibt zurück

Wenn ein Benutzer derzeit nicht bei diesem Hook angemeldet ist, wird eine Anmeldung aufgerufen. Fehlgeschlagene Anmeldungen können mithilfe des zurückgegebenen Anmelderückrufs erneut ausgeführt werden. Wenn ein Benutzer derzeit bei diesem Hook angemeldet ist, versucht, ein Token zu erwerben. Nachfolgende Tokenanforderungen können den zurückgegebenen AcquireToken-Rückruf verwenden. Geben Sie optional ein Anforderungsobjekt an, das im Login/AcquireToken-Aufruf verwendet werden soll. Geben Sie optional einen bestimmten Benutzer an, der angemeldet werden soll.

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

Parameter

Gibt zurück

Komponente mit höherer Reihenfolge umschließt die bereitgestellte Komponente mit Msal, indem Sie msal-Kontextwerte in die Eigenschaften der Komponente einfügen

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

Parameter

Gibt zurück

MsalConsumer: React.Consumer<IMsalContext>

Typ

MsalContext: React.Context<IMsalContext>

Typ

version: "3.0.29"

Typ