Information about a user's device

Alias

module:crypto/deviceinfo

Property

the ID of this device

Property

list of algorithms supported by this device

Property

a map from <key type>:<id> -> <base64-encoded key>>

Property

whether the device has been verified/blocked by the user

Property

whether the user knows of this device's existence (useful when warning the user that a user has added new devices)

Property

additional data from the homeserver

Param

id of the device

Hierarchy

  • DeviceInfo

Constructors

Properties

algorithms: string[] = []
deviceId: string
keys: Record<string, string> = {}
known: boolean = false
signatures: ISignatures = {}
unsigned: Record<string, any> = {}
verified: DeviceVerification = DeviceVerification.Unverified
DeviceVerification: {
    BLOCKED: DeviceVerification;
    UNVERIFIED: DeviceVerification;
    VERIFIED: DeviceVerification;
} = ...

Type declaration

Methods

  • Get the configured display name for this device, if any

    Returns

    displayname

    Returns null | string

  • Get the fingerprint for this device (ie, the Ed25519 key)

    Returns

    base64-encoded fingerprint of this device

    Returns string

  • Get the identity key for this device (ie, the Curve25519 key)

    Returns

    base64-encoded identity key of this device

    Returns string

  • Returns true if the user knows about this device's existence

    Returns

    true if known

    Returns boolean

  • Returns true if this device is unverified

    Returns

    true if unverified

    Returns boolean

  • Returns true if this device is verified

    Returns

    true if verified

    Returns boolean

Generated using TypeDoc