Функція showKBFromController
дозволяє відобразити екран бази знань (KB - Knowledge Base) у вашому iOS застосунку, надаючи користувачам швидкий доступ до статей і ресурсів. Ця функція є гнучкою у налаштуванні та підтримує локалізацію, кастомні опції та зворотні виклики для обробки взаємодії з користувачем.
Сигнатура функції
+ (void)showKBFromController:(UIViewController * _Nullable)viewController
viewType:(HCSViewType)viewType
forURL:(NSURL *)url
forceLanguageFromURL:(BOOL)forceLanguage
completion:(HCSCompletionHandler _Nullable)completion;
Параметри
Параметр | Тип | Дефолтне занчення | Опис |
---|---|---|---|
viewController | UIViewController? | null | ViewController з якого буде відкритий SDK |
viewType | HCSViewType | Can be omitted | Налаштуйте, як віджет чату відображатиме свій початковий стан |
url | NSURL | Required | URL-адреса статті, яка має відобразитися на екрані Бази знань. |
forceApplyLocaleFromUrl | Boolean | Required | Якщо true, SDK примусово застосує локаль відповідно до зазначеної в url. |
completion |
HCSCompletionHandler |
null | Опціональний зворотний виклик на успішне відкриття SDK або помилку |
Приклади використання
Відкриття статті Бази знань без додаткових налаштувань:
Swift:
HelpCrunch.showKB(from: self,
for: URL(string: "https://docs.helpcrunch.com/en/ios-sdk/configure-your-ios-app-in-helpcrunch"),
forceLanguageFromURL: false) { error in
}
ObjC:
[HelpCrunch showKBFromController:self
forURL:[NSURL URLWithString:@"https://docs.helpcrunch.com/en/ios-sdk/configure-your-ios-app-in-helpcrunch"]
forceLanguageFromURL:false
completion:^(NSError * _Nullable error) {
}];
Відкриття статті Бази знань тільки з вікном Бази
Swift:
HelpCrunch.showKB(from: nil,
viewType: .kbFirst,
for: URL(string: "https://docs.helpcrunch.com/en/ios-sdk/configure-your-ios-app-in-helpcrunch"),
forceLanguageFromURL: true) { error in
}
ObjC:
[HelpCrunch showKBFromController:nil
viewType:HCSViewTypeKbOnly
forURL:[NSURL URLWithString:@"https://docs.helpcrunch.com/en/ios-sdk/configure-your-ios-app-in-helpcrunch"]
forceLanguageFromURL:false
completion:^(NSError * _Nullable error) {
}];