Class IdentityManager

管理身份，支持身份的创建、登录、登出、更新和导入导出等操作

Constructors

constructor

Methods

createIdentity exportIdentity getActiveDid getActiveIdentity getBlockAddress getCurrentState getHistory getIdentity getNode importIdentity isLogin login logout updateIdentity

Constructors

constructor

Methods

createIdentity

  • createIdentity(password: string, template: IdentityTemplate): Promise<Identity>

    创建新身份，生成 BlockAddress 并加密存储，同时缓存登录信息

    Parameters

    • password: string

      身份密码

    • template: IdentityTemplate

      身份模板

    Returns Promise<Identity>

    返回创建的身份信息

    Example

    const template = { code: IdentityCodeEnum.IDENTITY_CODE_PERSONAL }
    const identity = await identityManager.createIdentity('example-password', template)

exportIdentity

  • exportIdentity(did: string): Promise<string>

    导出身份信息为 JSON 字符串，验证身份的完整性和合法性后返回序列化的身份信息

    Parameters

    • did: string

      身份的 DID

    Returns Promise<string>

    返回身份的 JSON 字符串

    Example

    const identityJson = await identityManager.exportIdentity('example-did')

getActiveDid

  • getActiveDid(): undefined | string

    获取当前登录的身份 DID

    Returns undefined | string

    返回当前登录的 DID，如果未登录则返回 undefined

    Example

    const activeDid = identityManager.getActiveDid()

getActiveIdentity

  • getActiveIdentity(): Promise<undefined | Identity>

    获取当前登录的身份信息

    Returns Promise<undefined | Identity>

    返回当前登录的身份对象，如果未登录则返回 undefined

    Example

    const activeIdentity = await identityManager.getActiveIdentity()

getBlockAddress

  • getBlockAddress(did: string): Promise<BlockAddress>

    获取身份的 BlockAddress

    Parameters

    • did: string

      身份的 DID

    Returns Promise<BlockAddress>

    返回解密后的 BlockAddress

    Example

    const blockAddress = await identityManager.getBlockAddress('example-did')

getCurrentState

  • getCurrentState(): Promise<IdentityState>

    获得当前身份状态

    Returns Promise<IdentityState>

getHistory

  • getHistory(): string[]

    获取历史登录记录

    Returns string[]

    返回历史登录的 DID 列表

    Example

    const history = identityManager.getHistory()

getIdentity

  • getIdentity(did: string): Promise<Identity>

    获取身份信息，如果身份已缓存，则直接返回；否则从本地缓存中加载并验证

    Parameters

    • did: string

      身份的 DID

    Returns Promise<Identity>

    返回身份信息

    Example

    const identity = await identityManager.getIdentity('example-did')

getNode

  • getNode(domain?: string): Promise<undefined | ServiceMetadata>

    获取当前节点信息

    Parameters

    • Optionaldomain: string

      可选的节点域名（默认为当前窗口的域名）

    Returns Promise<undefined | ServiceMetadata>

    返回节点的元数据

    Example

    const nodeMetadata = await identityManager.getNode()

importIdentity

  • importIdentity(content: string, password: string): Promise<Identity>

    导入身份信息，从 JSON 字符串导入身份，解密 BlockAddress 并缓存登录信息

    Parameters

    • content: string

      身份的 JSON 字符串

    • password: string

      身份密码

    Returns Promise<Identity>

    返回导入的身份信息

    Throws

    InvalidPassword 密码错误

    Example

    const identity = await identityManager.importIdentity(identityJson, 'example-password')

isLogin

  • isLogin(did: string): boolean

    检查是否已登录指定身份

    Parameters

    • did: string

      身份的 DID

    Returns boolean

    如果已登录，返回 true；否则返回 false

    Example

    const isLogged = identityManager.isLogin('example-did')

login

  • login(did: string, password: string): Promise<Identity>

    登录身份,解密身份信息

    Parameters

    • did: string

      身份的 DID

    • password: string

      登录密码

    Returns Promise<Identity>

    返回登录的身份信息

    Throws

    InvalidPassword 密码错误

    Example

    const identity = await identityManager.login('example-did', 'example-password')

logout

  • logout(): void

    登出当前身份

    Returns void

    Example

    identityManager.logout()

updateIdentity

  • updateIdentity(
        did: string,
        template: Partial<IdentityTemplate>,
        password?: string,
    ): Promise<Identity>

    更新身份信息， 解密 BlockAddress 并使用新的模板信息更新身份

    Parameters

    • did: string

      身份的 DID

    • template: Partial<IdentityTemplate>

      部分更新的身份模板

    • Optionalpassword: string

      身份密码，如果已登陆可以不用传密码

    Returns Promise<Identity>

    返回更新后的身份信息

    Throws

    InvalidPassword 密码错误

    Throws

    NoPermission 不允许执行更新操作

    Example

    const template = { extend: { name: 'New Name' } }
    const updatedIdentity = await identityManager.updateIdentity('example-did', template, 'example-password')

Settings

Member Visibility

On This Page

Constructors
Methods