@azure/msal-react package

Interfészek

IMsalContext

Típusaliasok

AccountIdentifiers

AuthenticatedTemplateProps

MsalAuthenticationProps

MsalAuthenticationResult

MsalProviderProps

SetComplement

SetDifference

Subtract

UnauthenticatedTemplateProps

WithMsalProps

Függvények

AuthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)	Gyermekösszetevők renderelése a felhasználó hitelesítése esetén
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 }>)	Megkísérli hitelesíteni a felhasználót, ha még nincs hitelesítve, majd megjeleníti a gyermekösszetevőket
MsalProvider(PropsWithChildren<{ instance: IPublicClientApplication }>)	MSAL-környezetszolgáltatói összetevő. Ezt az MSAL-t használó többi összetevő fölé kell renderelni.
UnauthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)	Gyermekösszetevők renderelése, ha a felhasználó nincs hitelesítve
useAccount(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)	Adott 1 vagy több accountIdentifiers, visszaadja a Fiók objektumot, ha a felhasználó bejelentkezett
useIsAuthenticated(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)	Azt adja vissza, hogy egy felhasználó jelenleg bejelentkezett-e. Igény szerint adjon meg 1 vagy több accountIdentifiers azonosítót annak megállapításához, hogy egy adott felhasználó bejelentkezett-e
useMsal()	Msal környezeti értékeket ad vissza
useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>, Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)	Ha egy felhasználó jelenleg nincs bejelentkezve ebben a horogban, bejelentkezést hív meg. A sikertelen bejelentkezések újrapróbálhatók a visszaadott bejelentkezési visszahívással. Ha egy felhasználó éppen be van jelentkezve ebben a horogban, megkísérli megszerezni a jogkivonatot. A későbbi jogkivonat-kérések használhatják a visszaadott acquireToken visszahívást. Igény szerint adjon meg egy kérelemobjektumot, amelyet a bejelentkezési/acquireToken-hívásban használni szeretne. Igény szerint adjon meg egy adott felhasználót, akibe be kell jelentkeznie.
withMsal<P>(ComponentType<P>)	Magasabb rendű összetevő csomagolja a megadott összetevőt a msal környezet értékeinek az összetevő támaszaiba történő injektálásával

Változók

MsalConsumer
MsalContext
version

Függvény adatai

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

Gyermekösszetevők renderelése a felhasználó hitelesítése esetén

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

Paraméterek

props

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

Válaszok

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

Megkísérli hitelesíteni a felhasználót, ha még nincs hitelesítve, majd megjeleníti a gyermekösszetevőket

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

Paraméterek

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

Válaszok

React.ReactElement | null

MsalProvider(PropsWithChildren<{ instance: IPublicClientApplication }>)

MSAL-környezetszolgáltatói összetevő. Ezt az MSAL-t használó többi összetevő fölé kell renderelni.

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

Paraméterek

__namedParameters

PropsWithChildren<{ instance: IPublicClientApplication }>

Válaszok

React.ReactElement

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

Gyermekösszetevők renderelése, ha a felhasználó nincs hitelesítve

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

Paraméterek

props

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

Válaszok

React.ReactElement | null

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

Adott 1 vagy több accountIdentifiers, visszaadja a Fiók objektumot, ha a felhasználó bejelentkezett

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

Paraméterek

accountIdentifiers

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

Válaszok

AccountInfo | null

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

Azt adja vissza, hogy egy felhasználó jelenleg bejelentkezett-e. Igény szerint adjon meg 1 vagy több accountIdentifiers azonosítót annak megállapításához, hogy egy adott felhasználó bejelentkezett-e

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

Paraméterek

matchAccount

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

Válaszok

boolean

useMsal()

Msal környezeti értékeket ad vissza

function useMsal(): IMsalContext

Válaszok

IMsalContext

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

Ha egy felhasználó jelenleg nincs bejelentkezve ebben a horogban, bejelentkezést hív meg. A sikertelen bejelentkezések újrapróbálhatók a visszaadott bejelentkezési visszahívással. Ha egy felhasználó éppen be van jelentkezve ebben a horogban, megkísérli megszerezni a jogkivonatot. A későbbi jogkivonat-kérések használhatják a visszaadott acquireToken visszahívást. Igény szerint adjon meg egy kérelemobjektumot, amelyet a bejelentkezési/acquireToken-hívásban használni szeretne. Igény szerint adjon meg egy adott felhasználót, akibe be kell jelentkeznie.

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

Paraméterek

interactionType

InteractionType

authenticationRequest

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

accountIdentifiers

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

Válaszok

MsalAuthenticationResult

withMsal<P>(ComponentType<P>)

Magasabb rendű összetevő csomagolja a megadott összetevőt a msal környezet értékeinek az összetevő támaszaiba történő injektálásával

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

Paraméterek

Component

ComponentType<P>

Válaszok

FunctionComponent<Subtract<P, WithMsalProps>>

Változó részletei

MsalConsumer

MsalConsumer: React.Consumer<IMsalContext>

Típus

React.Consumer<IMsalContext>

MsalContext

MsalContext: React.Context<IMsalContext>

Típus

React.Context<IMsalContext>

version

version: "3.0.29"

Típus

"3.0.29"