Class DeviceInfo

Information about a user's device

Hierarchy

  • DeviceInfo

Constructors

constructor

Properties

algorithms deviceId keys known signatures unsigned verified DeviceVerification

Methods

getDisplayName getFingerprint getIdentityKey isBlocked isKnown isUnverified isVerified toStorage fromStorage

Constructors

constructor

Properties

algorithms

algorithms: string[] = []

list of algorithms supported by this device

Readonly deviceId

deviceId: string

id of the device

keys

keys: Record<string, string> = {}

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

known

known: boolean = false

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

signatures

signatures: ISignatures = {}

unsigned

unsigned: Record<string, any> = {}

additional data from the homeserver

verified

verified: DeviceVerification = DeviceVerification.Unverified

whether the device has been verified/blocked by the user

Static DeviceVerification

DeviceVerification: {
    BLOCKED: DeviceVerification;
    UNVERIFIED: DeviceVerification;
    VERIFIED: DeviceVerification;
} = ...

Type declaration

Methods

getDisplayName

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

    Returns

    displayname

    Returns null | string

getFingerprint

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

    Returns

    base64-encoded fingerprint of this device

    Returns string

getIdentityKey

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

    Returns

    base64-encoded identity key of this device

    Returns string

isBlocked

isKnown

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

    Returns

    true if known

    Returns boolean

isUnverified

  • Returns true if this device is unverified

    Returns

    true if unverified

    Returns boolean

isVerified

  • Returns true if this device is verified

    Returns

    true if verified

    Returns boolean

toStorage

Static fromStorage

Settings

Member Visibility

Theme

Generated using TypeDoc