Browse SDKs · Flutter
Platform
SDKsFlutterEnterprise

Restore pending invitations

Restore unhandled call invitations upon app launch using the OpenIM Flutter SDK.

Copy

When the app launches, re-authenticates, or recovers from missed push notifications, call this method to retrieve any pending, still-valid call invitations:

Code example

final info = await OpenIM.iMManager.signalingManager
    .getSignalingInvitationInfoStartApp();

if (info.invitation?.roomID?.isNotEmpty == true) {
  restoreIncomingCall(info.invitation!, info.offlinePushInfo);
}

Return value

A successful Future returns a SignalingInfo object containing pending call invitations and offline push metadata available at launch.

FieldTypeDescription
userIDString?Operator user ID.
invitationInvitationInfo?Pending invitation details. If roomID is empty, no recoverable call exists.
offlinePushInfoOfflinePushInfo?Offline push notification payload.

This query returns only invitations that remain active when the application starts; if roomID is null or empty, dismiss any stale incoming call interfaces. After restoring an incoming call, continue monitoring timeout, cancellation, acceptance, and hang-up callbacks in Handle call events.