WelcomeResult
Holds the outcome of processing an MLS welcome message via Session:processWelcome.
A welcome message is sent by an existing group member when they commit a proposal to
add this client. Processing it transitions the session into the group and exposes the
initial roster. After inspecting the result, call destroy to free the underlying
handle.
Summary
Properties
Section titled “Properties”handle
Section titled “handle”Methods
Section titled “Methods”getRosterMemberIds
Section titled “getRosterMemberIds”WelcomeResult : getRosterMemberIds ( ) -> { string }
Returns the user IDs of every member present in the group when this welcome was issued, as a list of decimal snowflake strings. This is the initial roster after joining.
Returns
| { string } |
getRosterMemberSignature
Section titled “getRosterMemberSignature”WelcomeResult : getRosterMemberSignature ( rosterId ) -> buffer
Returns the MLS credential signature for the roster member identified by rosterId
(a decimal snowflake string). The signature bytes can be used to verify that the
member’s key package was signed by a trusted identity key.
Parameters
| rosterId: string |
Returns
| buffer |
destroy
Section titled “destroy”WelcomeResult : destroy ( ) -> ()
Destroys the welcome result and frees all associated libdave resources. Must be called after the result has been fully inspected.
Functions
Section titled “Functions”WelcomeResult . new ( handle ) -> WelcomeResult
Constructs a WelcomeResult wrapper around an existing libdave handle. Called internally
by Session:processWelcome.
Parameters
| handle: WelcomeResultHandle |
Returns
| WelcomeResult |