API

LOGIN_STATUS

定义登录状态的枚举类型。

| 成员 | 值 | 描述 | |---------|------|----------| | WAIT | 0 | 等待中 | | SUCCESS | 1 | 登录成功 | | FAILURE | 2 | 登录失败 | | LOGOUT | 3 | 登出 |

Object Types

USER_IDENTITY_NAME

将 USER_IDENTITY 枚举值映射到用户身份的字符串表示。

• TEACHER: '老师'
• STUDENT: '学生'
• ...
• SOCIAL_LEARNER: '社会学习者'

USER_IDENTITY_TEXT

将 USER_IDENTITY 枚举值映射到用户身份的完整句子。

• TEACHER: '我是老师'
• STUDENT: '我是学生'
• ...
• SOCIAL_LEARNER: '我是社会学习者'

UserProviderProps

定义 UserProvider 组件的属性。

| 属性 | 类型 | 描述 | |---------------------|------------------|------------------------------| | children | React.ReactNode | 子组件 | | pathConfig | { MiddlePagePath: string[] } | 中间页面路径配置（可选） | | config | { uc: UC } | 包含UC配置的对象 |

UserProviderValue

定义用户上下文提供者的价值/状态。

| 属性 | 类型 | 描述 | |---------------------|----------------------------------|------------------------------| | loginStatus | LOGIN_STATUS | 登录状态 | | userInfo | UserInfo | 用户信息 | | allUserRole | USER_IDENTITY[] | 所有用户角色 | | userRole | USER_IDENTITY | null | 用户角色 | | setUserInfo | (userInfo: UserInfo) => void | 设置用户信息的函数 | | setAllUserRole | (allUserRole: USER_IDENTITY[]) => void | 设置所有用户角色的函数 | | setUserRole | (userRole: USER_IDENTITY) => void | 设置用户角色的函数 | | uc | UC | UC对象 | | Auth | ReturnType<typeof getAuth> | getAuth 函数返回的认证对象 |