帐号功能

更新时间：2025-12-05 19:04:23

帐号功能包括：用户登录、登出等功能。开发可先阅读用户账号开发指南

接口与类型定义详见sdk中dist目录下index.d.ts文件

/**
 * 自建帐号OAuth2协议登录
 * @param token - 自建帐号用户token
 * @returns
 * @public
 */
declare function loginByAuth2(authCode: string): Promise<IUserLoginResp>;

/**
 * 帐号密码登录
 * @param account - 帐号
 * @param password - 密码
 * @public
 */
declare function loginByPassword(account: string, password: string): Promise<IUserLoginResp>;

/**
 * 用户token登录
 * @param jwtToken - 用户token
 * @param userId - 用户ID 可选 不传会尝试从jwtToken中解uid字段
 * @param tokenExpireTime - 失效时间，单位：毫秒 可选 不传会尝试从jwtToken中解exp字段
 * @public
 */
declare function loginByToken(jwtToken: string, userId?: number, tokenExpireTime?: number): void;

/**
 * 退出登录
 * @public
 */
declare function logout(): Promise<void>;

/**
 * 设置用户token失效监听
 * @param onTokenInvalidListener - 监听回调
 * @public
 */
declare function setOnTokenInvalidListener(listener: OnTokenInvalidListener): void;

export declare namespace RTCXAccount {
    export {
        loginByPassword,
        loginByAuth2,
        logout
    }
}

内置帐号

用户登录

import {
  RTCXAccount,
} from '@rtcx/websdk'
const account = '帐号'
const password = '密码'
RTCXAccount.loginByPassword(account, password)

用户Token登录

当应用层已经从其它途径获取到用户登录token，可直接设置给SDK

import {
  RTCXAccount,
} from '@rtcx/websdk'
RTCXAccount.loginByToken(jwtToken: string, userId?: number, tokenExpireTime?: number)

用户登出

import {
  RTCXAccount,
} from '@rtcx/websdk'
RTCXAccount.logout()

登录失效监听

import {
  RTCXAccount,
  RTCXAccountTypes
} from '@rtcx/websdk'
/**
 * 用户token失效监听
 * @public
 */
const onTokenInvalidListener: RTCXAccountTypes.OnTokenInvalidListener = (err: RuntimeException) => {};
RTCXAccount.setOnTokenInvalidListener(onTokenInvalidListener)

自有帐号体系

用户登录

import {
  RTCXAccount,
} from '@rtcx/websdk'
const authCode = '授权code'
RTCXAccount.loginByAuth2(authCode)

登录失效监听

同【内置帐号】的【登录失效监听】