Додайте HelpCrunch iOS SDK до свого застосунку

Ви можете додати HelpCrunch SDK до свого застосунку iOS вручну, а також за допомогою CocoaPods або Carthage.
Написано Микола
Оновлено 2 місяці тому

CocoaPods

CocoaPods — це менеджер залежностей для проектів Swift і Objective-C Cocoa. Він має понад 43 тисячі бібліотек і використовується понад 3 мільйонами застосунків. CocoaPods може допомогти вам легко масштабувати ваші проєкти. Якщо ви не використовували його раніше, почніть тут.

Щоб інтегрувати HelpCrunch у ваш проєкт Xcode за допомогою CocoaPods, вкажіть його у своєму Podfile (текстовий файл у каталозі проекту Xcode з назвою Podfile):

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '11.0'
use_frameworks!
target 'ProjectTargetName' do
  pod 'HelpCrunchSDK', '~> 4.0'
end

Тепер ви можете встановити залежності у своєму проєкті:

$ pod install

Під час створення проекту завжди відкривайте робочу область Xcode замість файлу проекту:

$ open App.xcworkspace

Carthage

Carthage — це ще один спосіб додати фреймворки до вашого застосунку Cocoa. Він створює ваші залежності та надає вам бінарні фреймворки, але ви зберігаєте повний контроль над структурою та налаштуванням вашого проєкту. Carthage не змінює автоматично файли проекту або налаштування білдів.

Якщо ви ще його не встановили, перегляньте цю інструкцію.

1. Створіть Cartfile в тій самій директорії, де знаходиться .xcodeproj або  .xcworkspace .

2. Відкрийте Cartfile та додайте наступне:

github "helpcrunch/helpcrunchsdk-ios" ~> 4.0

3. ...потім запустіть наступне:

$ carthage update --no-build

Якщо ви бачите якісь помилки, спробуйте виконати таку команду:

rm -rf ~/Library/Caches/org.carthage.CarthageKit

4. Відкрийте Загальні налаштування.

5. Перетягніть білд HelpcrunchSDK.xcframework із Carthage/Checkouts/helpcrunchsdk-ios у розділ Embedded Binaries. Не забудьте вибрати опцію "Скопіювати елементи", якщо потрібно.

Swift Package Manager

SPM — це сучасний спосіб додати бібліотеки до вашого проекту. Він має вбудований Xcode, тому вам не потрібно встановлювати додаткові інструменти.

Ви можете додати HelpCrunchSDK як репозиторій Swift Package в Xcode. Зробити це можна, натиснувши на:

File -> Swift Packages -> Add Package Dependency... 

чи

Project -> YOUR_PROJECT_NAME -> Swift Packages -> +.

Потім додайте цей URL:

https://github.com/helpcrunch/helpcrunchsdk-ios

А потім просто дотримуйтесь інструкцій на екрані.

Ручна установка

Для встановлення нашого SDK вручну знадобиться кілька додаткових кроків.

1. Завантажте HelpcrunchSDK.xcframework з GitHub і скопіюйте його в розділ Embedded Binaries. Не забудьте вибрати "Скопіювати елементи", якщо потрібно.

Код налаштування

Якщо ви ще не користуєтесь Swift UI, ознайомтеся з цією статею для початку.

1. Додайте наступний імпорт у верхній частині AppDelegate.m або AppDelegate.swift:

ObjC:

@import HelpCrunchSDK;

Swift:

import HelpCrunchSDK

2. Ініціалізуйте конфігурацію Helpcrunch SDK:

ObjC:

HCSConfiguration *configuration =
[HCSConfiguration configurationForOrganization:@"YOUR_HELPCRUNCH_SUBDOMAIN"
applicationId:@"YOUR_APP_ID"
applicationSecret:@"YOUR_APP_SECRET"];

Swift:

let configuration =
HCSConfiguration(forOrganization: "YOUR_HELPCRUNCH_SUBDOMAIN",
applicationId: "YOUR_APP_ID",
applicationSecret: "YOUR_APP_SECRET")

3. Ініціалізуйте SDK з конфігурацією.

ObjC:

[HelpCrunch initWithConfiguration:configuration
user:nil
completion:^(NSError * _Nullable error) {
// Do something on SDK init completion
}];

Swift:

HelpCrunch.initWith(configuration, user: nil) { (error) in
// Do something on SDK init completion
}

Ви можете скопіювати цей код зі списку застосунків у вашому обліковому записі HelpCrunch.

4. Ви завжди можете перевірити перелік стейту, щоб отримати поточний стейт SDK. Він може бути Idle, Loading, Error, UserIsBlocked чи Ok для того, щоб ви могли належним чином показати або приховати кнопку "Зв'язатися з нами". Також є подія сповіщення HCSStateChangedNotification, щоб завжди бути в курсі подій.

ObjC:

[HelpCrunch state]

Swift:

HelpCrunch.state()

5. Щоб показати HelpCrunch UI, просто викликайте допоміжний метод showFromController у HelpCrunch:

ObjC:

[HelpCrunch showFromController:viewController completion:^(NSError * _Nullable error) {
// If you need to do something on completion of SDK view controller presenting
}];

Swift:

HelpCrunch.show(from: viewController) { (error) in
// If you need to do something on completion of SDK view controller presenting
}

viewController необхідний для представлення контролера.

6. Перевірити, чи відображається зараз ваш чат, можна за допомогою:

ObjC:

[HelpCrunch isVisible]

Swift:

HelpCrunch.isVisible()

7. Після того, як ви викликали метод showFromController, ваш віджет чату матиме такий вигляд:

8. Якщо потрібно, ви можете автоматично закривати чат HelpCrunch, просто викликаючи метод closeChatWithCompletion 

Оновлення Info.plist

Щоб надсилати файли та фотографії, у вашому Info.plist потрібно мати записи NSCameraUsageDescription, NSPhotoLibraryAddUsageDescription і NSPhotoLibraryUsageDescription. Ці записи вимагаються Apple.

Користувачі бачитимуть відповідний наданий вами текст, і їх буде перенаправлено на сторінку дозволів камери/галерею фотографій, коли вони намагатимуться використати свою камеру або відкрити/зберегти зображення в галерею фотографій.

  • NSCameraUsageDescription – коли користувачі намагаються використовувати свою камеру.
  • NSPhotoLibraryUsageDescription – коли користувачі намагаються відкрити свою галерею фотографій.
  • NSPhotoLibraryAddUsageDescription – коли користувачі намагаються зберегти зображення у свою галерею фотографій.
Чи була наша стаття корисною?