Interface KeyPackageEligibility

The outcome of evaluating a KeyPackage against a group's add requirements.

interface KeyPackageEligibility {
    alreadyMember: boolean;
    cipherSuite: number;
    eligible: boolean;
    reasons: string[];
}

Core - Key Package

alreadyMember: boolean

True when the KeyPackage's account is already a member of the group.

cipherSuite: number

The KeyPackage's MLS cipher suite id, or -1 if the event was undecodable.

eligible: boolean

True when the KeyPackage satisfies every add requirement (no reasons).

reasons: string[]

Human-readable reasons the KeyPackage is not eligible (empty when it is).