Class CollectStrategy

Strategy to collect the devices that should receive room keys for the current discussion.

Methods

eq free deviceBasedStrategy identityBasedStrategy

Methods

eq

  • eq(other: CollectStrategy): boolean

  • Tests for equality between two [CollectStrategy]s.

    Parameters

    Returns boolean

free

  • free(): void

  • Returns void

StaticdeviceBasedStrategy

  • deviceBasedStrategy(
        only_allow_trusted_devices: boolean,
        error_on_verified_user_problem: boolean,
    ): CollectStrategy

  • Device based sharing strategy.

    If only_allow_trusted_devices is true, devices that are not trusted will be excluded from the conversation. A device is trusted if any of the following is true: - It was manually marked as trusted. - It was marked as verified via interactive verification. - It is signed by its owner identity, and this identity has been trusted via interactive verification. - It is the current own device of the user.

    If error_on_verified_user is true, and a verified user has an unsigned device, key sharing will fail with an error.

    If error_on_verified_user is true, and a verified user has replaced their identity, key sharing will fail with an error.

    Otherwise, keys are shared with unsigned devices as normal.

    Once the problematic devices are blacklisted or whitelisted the caller can retry to share a second time.

    Parameters

    • only_allow_trusted_devices: boolean
    • error_on_verified_user_problem: boolean

    Returns CollectStrategy

StaticidentityBasedStrategy

  • identityBasedStrategy(): CollectStrategy

  • Share based on identity. Only distribute to devices signed by their owner. If a user has no published identity he will not receive any room keys.

    Returns CollectStrategy

Settings

Member Visibility

On This Page

Methods