|
1 | | -[**oidc-react**](../README.md) • **Docs** |
| 1 | +[**oidc-react**](../README.md) |
2 | 2 |
|
3 | 3 | *** |
4 | 4 |
|
5 | 5 | [oidc-react](../README.md) / AuthContextProps |
6 | 6 |
|
7 | 7 | # Interface: AuthContextProps |
8 | 8 |
|
| 9 | +Defined in: [auth-context-interface.ts:153](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L153) |
| 10 | + |
9 | 11 | ## Properties |
10 | 12 |
|
11 | 13 | ### isLoading |
12 | 14 |
|
13 | 15 | > **isLoading**: `boolean` |
14 | 16 |
|
15 | | -Auth state: True until the library has been initialized. |
16 | | - |
17 | | -#### Defined in |
| 17 | +Defined in: [auth-context-interface.ts:185](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L185) |
18 | 18 |
|
19 | | -[src/auth-context-interface.ts:181](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L181) |
| 19 | +Auth state: True until the library has been initialized. |
20 | 20 |
|
21 | 21 | *** |
22 | 22 |
|
23 | 23 | ### signIn() |
24 | 24 |
|
25 | | -> **signIn**: (`args`?) => `Promise`\<`void`\> |
| 25 | +> **signIn**: (`args?`) => `Promise`\<`void`\> |
| 26 | +
|
| 27 | +Defined in: [auth-context-interface.ts:157](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L157) |
26 | 28 |
|
27 | 29 | Alias for userManager.signInRedirect |
28 | 30 |
|
29 | 31 | #### Parameters |
30 | 32 |
|
31 | | -• **args?**: `SigninRedirectArgs` |
| 33 | +##### args? |
| 34 | + |
| 35 | +`SigninRedirectArgs` |
32 | 36 |
|
33 | 37 | #### Returns |
34 | 38 |
|
35 | 39 | `Promise`\<`void`\> |
36 | 40 |
|
37 | | -#### Defined in |
| 41 | +*** |
| 42 | + |
| 43 | +### signInCallback() |
38 | 44 |
|
39 | | -[src/auth-context-interface.ts:157](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L157) |
| 45 | +> **signInCallback**: () => `Promise`\<`void`\> |
| 46 | +
|
| 47 | +Defined in: [auth-context-interface.ts:161](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L161) |
| 48 | + |
| 49 | +Alias for userManager.signInCallback |
| 50 | + |
| 51 | +#### Returns |
| 52 | + |
| 53 | +`Promise`\<`void`\> |
40 | 54 |
|
41 | 55 | *** |
42 | 56 |
|
43 | 57 | ### signInPopup() |
44 | 58 |
|
45 | 59 | > **signInPopup**: () => `Promise`\<`void`\> |
46 | 60 |
|
| 61 | +Defined in: [auth-context-interface.ts:165](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L165) |
| 62 | + |
47 | 63 | Alias for userManager.signinPopup |
48 | 64 |
|
49 | 65 | #### Returns |
50 | 66 |
|
51 | 67 | `Promise`\<`void`\> |
52 | 68 |
|
53 | | -#### Defined in |
54 | | - |
55 | | -[src/auth-context-interface.ts:161](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L161) |
56 | | - |
57 | 69 | *** |
58 | 70 |
|
59 | 71 | ### signOut() |
60 | 72 |
|
61 | 73 | > **signOut**: () => `Promise`\<`void`\> |
62 | 74 |
|
| 75 | +Defined in: [auth-context-interface.ts:169](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L169) |
| 76 | + |
63 | 77 | Alias for removeUser |
64 | 78 |
|
65 | 79 | #### Returns |
66 | 80 |
|
67 | 81 | `Promise`\<`void`\> |
68 | 82 |
|
69 | | -#### Defined in |
70 | | - |
71 | | -[src/auth-context-interface.ts:165](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L165) |
72 | | - |
73 | 83 | *** |
74 | 84 |
|
75 | 85 | ### signOutRedirect() |
76 | 86 |
|
77 | | -> **signOutRedirect**: (`args`?) => `Promise`\<`void`\> |
| 87 | +> **signOutRedirect**: (`args?`) => `Promise`\<`void`\> |
| 88 | +
|
| 89 | +Defined in: [auth-context-interface.ts:173](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L173) |
78 | 90 |
|
79 | 91 | #### Parameters |
80 | 92 |
|
81 | | -• **args?**: `SignoutRedirectArgs` |
| 93 | +##### args? |
| 94 | + |
| 95 | +`SignoutRedirectArgs` |
82 | 96 |
|
83 | 97 | #### Returns |
84 | 98 |
|
85 | 99 | `Promise`\<`void`\> |
86 | 100 |
|
87 | | -#### Defined in |
88 | | - |
89 | | -[src/auth-context-interface.ts:169](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L169) |
90 | | - |
91 | 101 | *** |
92 | 102 |
|
93 | 103 | ### userData? |
94 | 104 |
|
95 | 105 | > `optional` **userData**: `null` \| `User` |
96 | 106 |
|
97 | | -See [User](https://authts.github.io/oidc-client-ts/classes/User.html) for more details. |
98 | | - |
99 | | -#### Defined in |
| 107 | +Defined in: [auth-context-interface.ts:181](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L181) |
100 | 108 |
|
101 | | -[src/auth-context-interface.ts:177](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L177) |
| 109 | +See [User](https://authts.github.io/oidc-client-ts/classes/User.html) for more details. |
102 | 110 |
|
103 | 111 | *** |
104 | 112 |
|
105 | 113 | ### userManager |
106 | 114 |
|
107 | 115 | > **userManager**: `UserManager` |
108 | 116 |
|
109 | | -See [UserManager](https://authts.github.io/oidc-client-ts/classes/UserManager.html) for more details. |
110 | | - |
111 | | -#### Defined in |
| 117 | +Defined in: [auth-context-interface.ts:177](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L177) |
112 | 118 |
|
113 | | -[src/auth-context-interface.ts:173](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L173) |
| 119 | +See [UserManager](https://authts.github.io/oidc-client-ts/classes/UserManager.html) for more details. |
0 commit comments