A pickled version of an InboundGroupSession.

Holds all the information that needs to be stored in a database to restore an InboundGroupSession.

Constructors

Properties

Accessors

Methods

Constructors

Properties

backedUp: boolean

Flag remembering if the session has been backed up.

imported: boolean

Flag remembering if the session was directly sent to us by the sender or if it was imported.

pickle: string

The pickle string holding the Megolm Session, as returned by olm_pickle_inbound_group_session in libolm.

senderKey: string

The public curve25519 key of the account that sent us the session.

Accessors

  • get roomId(): undefined | RoomId
  • The id of the room that the session is used in.

    Nullable so that a PickledInboundGroupSession can be constructed incrementally. Must be populated!

    Returns undefined | RoomId

  • set roomId(value: undefined | null | RoomId): void
  • The id of the room that the session is used in.

    Nullable so that a PickledInboundGroupSession can be constructed incrementally. Must be populated!

    Parameters

    • value: undefined | null | RoomId

    Returns void

  • get senderSigningKey(): undefined | string
  • The public ed25519 key of the account that is believed to have initiated the session, if known.

    If the session was received directly from the creator via an Olm-encrypted m.room_key event, this value is taken from the keys property of the plaintext payload of that event (see m.olm.v1.curve25519-aes-sha2).

    If the session was forwarded to us using an m.forwarded_room_key, this value is a copy of the sender_claimed_ed25519_key from the content of the event.

    Returns undefined | string

  • set senderSigningKey(value: undefined | null | string): void
  • The public ed25519 key of the account that is believed to have initiated the session, if known.

    If the session was received directly from the creator via an Olm-encrypted m.room_key event, this value is taken from the keys property of the plaintext payload of that event (see m.olm.v1.curve25519-aes-sha2).

    If the session was forwarded to us using an m.forwarded_room_key, this value is a copy of the sender_claimed_ed25519_key from the content of the event.

    Parameters

    • value: undefined | null | string

    Returns void

Methods

  • Returns void