CalKit user guide

dependencies:
    # Enter the SDK version number.
    # Check the latest version of the plugin at https://pub.dev/packages/zego_callkit and replace `x.y.z` with the version number.
    zego_callkit: ^x.y.z

CallKit.setInitConfiguration(CXProviderConfiguration(localizedName: 'Your App Name or others'));   

CallKitEventHandler.didReceiveIncomingPush = (Map extras ,UUID uuid){
    // Extract the payload field passed with the push notification.
    Map payload = extras['payload'];
};

// Call the `setInitConfiguration` method at least once before pulling CallKit.
CallKit.setInitConfiguration(CXProviderConfiguration(localizedName: 'ZEGO'));

CallKit.getInstance().reportIncomingCall(CXCallUpdate(), UUID.getUUID()).catchError((onError){
// Error message for a failure.
}).then((value) => {
// The call UI is launched.
});

// `CXCallEndedReason` indicate the reason why an incoming call is ended. In the sample code, the call is declined by the caller.
// `uuid` is the UUID obtained from the `didReceiveIncomingPush` method or that passed by the `reportIncomingCall` method.
CallKit.getInstance().reportCallEnded(CXCallEndedReason.CXCallEndedReasonRemoteEnded, uuid);

// Callbacks when a VoIP push notification is received.
// `uuid` is the unique ID of the call.
CallKitEventHandler.didReceiveIncomingPush = (Map extras, UUID uuid){
    // The payload string is the same as the extended data carried in the `ZIMPushConfig` class.
    Map payload = extras['payload'];
};

// The event that the user taps the Answer button.
CallKitEventHandler.performAnswerCallAction = (CXAnswerCallAction action){
  
};
// The event that the user taps the Decline button.
CallKitEventHandler.performEndCallAction = (CXEndCallAction action){
  
};
// The event that the user taps the Mute button.
CallKitEventHandler.performSetMutedCallAction = (CXSetMutedCallAction action){
    // If the Mute button is tapped, `muted` is set to `true`.
    action.muted;
};

// To initialize CallKit, set `supportsVideo_` to  `true`.
var config = CXProviderConfiguration(localizedName: 'localizedName');
config.supportsVideo_ = true;
CallKit.setInitConfiguration(config);

// `CXCallUpdate.hasVideo` must be set to `true`.
CXCallUpdate update = CXCallUpdate();
update.hasVideo = true;
// To redirect the user to the app after the user taps the Video button on the call UI, you also need to set `remoteHandle`.
update.remoteHandle = CXHandle(type: CXHandleType.CXHandleTypeGeneric, value: 'Caller information');
// Generate the unique ID of the call.
UUID uuid = UUID.getUUID();
CallKit.getInstance().reportIncomingCall(update, uuid);

pushConfig.title = "System call title";
pushConfig.payload = "Field to be passed";
pushConfig.resourcesID = "Contact ZEGO technical support to obtain the value";

ZIMVoIPConfig voIPConfig = ZIMVoIPConfig();
voIPConfig.iOSVoIPHandleType = ZIMCXHandleType.generic;
// Sender information.
voIPConfig.iOSVoIPHandleValue = "Li hua";
// Whether a video call is initiated.
voIPConfig.iOSVoIPHasVideo = true;
pushConfig.voIPConfig = voIPConfig;

- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler{
    INInteraction *interaction = userActivity.interaction;
    INIntent *intent = interaction.intent;
    // When the user tap the Video button, the following condition is met. Note that the event can be triggered by tapping the button or an entry in the call history.
    if([userActivity.activityType isEqual:@"INStartVideoCallIntent"]){
        INPerson *person = [(INStartAudioCallIntent *)intent contacts][0];
        // The `CXHandle` field in the `ZIMVoIPConfig` class is obtained, which can be used to implement your business logic.
        CXHandle *handle = [[CXHandle alloc] initWithType:(CXHandleType)person.personHandle.type value:person.personHandle.value];
        // The following sample UI information will be displayed in a pop-up window.
        UIAlertController *alertView = [UIAlertController alertControllerWithTitle:@"tips" message:[NSString stringWithFormat:@"If the user action type is `INStartVideoCallIntent`, the video mode is used. User information: %@",handle.value] preferredStyle:UIAlertControllerStyleAlert];
        UIAlertAction *action = [UIAlertAction actionWithTitle:@"OK" style:UIAlertActionStyleDefault handler:^(UIAlertAction * _Nonnull action) {
        }];
        [alertView addAction:action];
        [[UIViewControllerCJHelper findCurrentShowingViewController] presentViewController:alertView animated:YES completion:nil];
        return true;
    }
    return false;
}