Options
All
  • Public
  • Public/Protected
  • All
Menu

Struct representing a cross signing identity of a user.

This is the user identity of a user that is our own.

Hierarchy

  • OwnUserIdentity

Index

Constructors

Properties

masterKey: string

Get the master key of the identity.

selfSigningKey: string

Get the self-signing key of the identity.

userSigningKey: string

Get the user-signing key of the identity. This is only present for our own user identity.

Methods

  • free(): void
  • Returns void

  • hasVerificationViolation(): boolean
  • Was this identity verified since initial observation and is not anymore?

    Such a violation should be reported to the local user by the application, and resolved by

    Returns boolean

  • isVerified(): boolean
  • Is this user identity verified?

    Returns boolean

  • requestVerification(methods?: any[]): Promise<any>
  • Send a verification request to our other devices.

    Parameters

    • Optional methods: any[]

    Returns Promise<any>

  • trustsOurOwnDevice(): Promise<any>
  • Does our user identity trust our own device, i.e. have we signed our own device keys with our self-signing key?

    Returns Promise<any>

  • verify(): Promise<any>
  • Mark our user identity as verified.

    This will mark the identity locally as verified and sign it with our own device.

    Returns a signature upload request that needs to be sent out.

    Returns Promise<any>

  • wasPreviouslyVerified(): boolean
  • True if we verified our own identity at some point in the past.

    To reset this latch back to false, call withdrawVerification.

    Returns boolean

  • withdrawVerification(): Promise<any>
  • Remove the requirement for this identity to be verified.

    If an identity was previously verified and is not any longer, it will be reported to the user. In order to remove this notice users have to verify again or to withdraw the verification requirement.

    Returns Promise<any>

Generated using TypeDoc