@azure/msal-react package

Vykreslí podřízené komponenty, pokud je uživatel ověřený.

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

Parametry

Návraty

Pokusí se ověřit uživatele, pokud ještě není ověřený, vykreslí podřízené komponenty.

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

Návraty

Komponenta zprostředkovatele kontextu MSAL. Musí se vykreslit nad všemi ostatními komponentami, které používají knihovnu MSAL.

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

Parametry

Návraty

Vykreslí podřízené komponenty, pokud uživatel není ověření.

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

Parametry

Návraty

Při zadání 1 nebo více identifikátorů účtů vrátí objekt Account, pokud je uživatel přihlášený.

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

Parametry

Návraty

Vrátí, jestli je uživatel aktuálně přihlášený. Volitelně můžete zadat 1 nebo více identifikátorů účtů, které určují, jestli je konkrétní uživatel přihlášený.

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

Parametry

Návraty

Vrátí hodnoty msal context.

function useMsal(): IMsalContext

Návraty

Pokud uživatel není aktuálně přihlášený, vyvolá přihlášení. Neúspěšná přihlášení je možné opakovat pomocí vráceného zpětného volání pro přihlášení. Pokud je uživatel aktuálně přihlášený, pokusí se získat token. Následné žádosti o token můžou použít vrácené zpětné volání acquireToken. Volitelně zadejte objekt požadavku, který se má použít ve volání login/acquireToken. Volitelně můžete zadat konkrétního uživatele, který by se měl přihlásit.

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

Návraty

Komponenta vyššího řádu zabalí poskytovanou komponentu msal vložením hodnot kontextu msal do props komponenty.

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

Parametry

Návraty

MsalConsumer: React.Consumer<IMsalContext>

Typ

MsalContext: React.Context<IMsalContext>

Typ

version: "3.0.29"

Typ