@azure/msal-react package

Kullanıcının kimliği doğrulanmışsa alt bileşenleri işler

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

Parametreler

Döndürülenler

Henüz kimliği doğrulanmamışsa kullanıcının kimliğini doğrulamayı dener, ardından alt bileşenleri işler

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

Parametreler

Döndürülenler

MSAL bağlam sağlayıcısı bileşeni. Bu, MSAL kullanan diğer bileşenlerin üzerinde işlenmelidir.

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

Parametreler

Döndürülenler

Kullanıcı kimliği doğrulanmamışsa alt bileşenleri işler

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

Parametreler

Döndürülenler

1 veya daha fazla accountIdentifiers verildiğinde, kullanıcı oturum açmışsa Account nesnesini döndürür

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

Parametreler

Döndürülenler

Kullanıcının şu anda oturum açıp açmadığını döndürür. İsteğe bağlı olarak, belirli bir kullanıcının oturum açıp açmadığını belirlemek için 1 veya daha fazla accountIdentifiers sağlayın

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

Parametreler

Döndürülenler

Msal Bağlam değerlerini döndürür

function useMsal(): IMsalContext

Döndürülenler

Bir kullanıcı şu anda bu kancada oturum açmadıysa bir oturum açma çağırır. Başarısız oturum açma işlemleri, döndürülen oturum açma geri çağrısı kullanılarak yeniden denenebilir. Bir kullanıcı şu anda bu kancada oturum açmışsa bir belirteç almayı dener. Sonraki belirteç istekleri döndürülen acquireToken geri çağırmasını kullanabilir. İsteğe bağlı olarak login/acquireToken çağrısında kullanılacak bir istek nesnesi sağlayın. İsteğe bağlı olarak oturum açması gereken belirli bir kullanıcı sağlayın.

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

Parametreler

Döndürülenler

Daha yüksek sıralı bileşen, msal bağlam değerlerini bileşenin props içine ekleyerek sağlanan bileşeni msal ile sarmalar

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

Parametreler

Döndürülenler

MsalConsumer: React.Consumer<IMsalContext>

Tür

MsalContext: React.Context<IMsalContext>

Tür

version: "3.0.29"

Tür