CoGuestStore class abstract

Live co-guest management related interfaces, managing co-guest application, invitation, acceptance, rejection and other operations between hosts and audience.

CoGuestStore Manages all co-guest related operations between hosts and audience, including application, invitation, acceptance and rejection processes. Co-guest feature enables real-time interaction between hosts and audience members through a seat-based system. CoGuestStore provides a comprehensive set of APIs to manage the entire co-guest lifecycle.

Key Features

• Bidirectional Invitation：Hosts can invite audience members, and audience members can also apply to join
• State Management：Real-time tracking of connected users, invitations and applications
• Event-Driven Architecture：Provides separate event streams for host and guest roles
• Timeout Handling：Built-in timeout mechanism for invitations and applications

Important: Always use the factory method CoGuestStore.create with a valid live room ID to create a CoGuestStore instance. Do not attempt to initialize directly.

Note: Co-guest state updates are delivered through the coGuestState publisher. Subscribe to it to receive real-time updates about connected users, invitations and applications.

Co-Guest Workflow

The following table shows a typical co-guest workflow

Host-Initiated Flow

Usage Example

// Create store instance
final store = CoGuestStore.create('live_room_123');

// Define listeners
late final VoidCallback connectedListener = _onConnectedChanged;
late final VoidCallback applicantsListener = _onApplicantsChanged;

void _onConnectedChanged() {
    print('Connected users: ${store.coGuestState.connected.value.length}');
}

void _onApplicantsChanged() {
    print('Pending applications: ${store.coGuestState.applicants.value.length}');
}

// Subscribe to state changes
store.coGuestState.connected.addListener(connectedListener);
store.coGuestState.applicants.addListener(applicantsListener);

// Add host event listener (for hosts)
final hostListener = HostListener(
    onGuestApplicationReceived: (guestUser) {
        print('Received application from ${guestUser.userName}');
        // Show accept/reject UI
    },
    onHostInvitationResponded: (isAccept, guestUser) {
        print('Audience ${guestUser.userName} ${isAccept ? "accepted" : "rejected"}');
    },
);
store.addHostListener(hostListener);

// Host: Accept application
final result = await store.acceptApplication('user_456');
if (result.code == 0) {
    print('Application accepted successfully');
}

// Unsubscribe when done
store.coGuestState.connected.removeListener(connectedListener);
store.coGuestState.applicants.removeListener(applicantsListener);
store.removeHostListener(hostListener);

Topics

Creating Instance

• CoGuestStore.create : Create object instance

Observing State and Events

• coGuestState : Reactive state containing connected users, invitees, applicants and candidates
• addHostListener/removeHostListener : Host-side event callbacks
• addGuestListener/removeGuestListener : Guest-side event callbacks

Guest Operations

• applyForSeat : Guest applies for co-guest
• cancelApplication : Guest cancels application
• acceptApplication : Host accepts application
• rejectApplication : Host rejects application

Host Operations

• inviteToSeat : Host invites guest to co-guest
• cancelInvitation : Host cancels invitation
• acceptInvitation : Guest accepts invitation
• rejectInvitation : Guest rejects invitation

Connection Control

• disconnect : End co-guest session

See Also

• NoResponseReason
• CoGuestState
• HostListener
• GuestListener