SDK na iOS
Zaktualizowano
SDK ChatFrom na iOS umieszcza Twojego chatbota w Twojej własnej aplikacji na iPhone'a i iPada: jako dymek czatu w rogu albo wiersz na liście. Dotknięcie otwiera czat, na iPhonie na pełnym ekranie, a na iPadzie jako kartę, z tą samą wiedzą, tymi samymi narzędziami i workflowami co na Twojej stronie, a każda rozmowa trafia do tego samego dziennika.
Jak to działa
Dymek i nagłówek czatu rysuje sama aplikacja, w kolorze, z ikoną, w rozmiarze i w rogu, które wybierasz w sekcji Deploy. Czat w środku to strona czatu ChatFrom, więc każde ulepszenie trafia do Twojej aplikacji bez nowego wydania. Użytkownicy mogą załączać pliki, otwierać linki, które otwierają się poza Twoją aplikacją, i wracać do rozmowy tam, gdzie ją przerwali.
Czat wymaga iOS 16.4 lub nowszego. Pakiet można dodać do aplikacji, która nadal obsługuje iOS 15: na takim systemie nie pokazuje dymka, a jego wiersze są szare. ChatFrom.isSupported podaje, który przypadek dotyczy danego urządzenia.
Zanim zaczniesz
- W ChatFrom otwórz swojego chatbota, przejdź do Deploy i włącz Mobile apps. Następnie uruchom chatbota. Chatbot, który nie jest uruchomiony albo nie jest otwarty dla aplikacji, nie pokazuje dymka.
- Skopiuj identyfikator chatbota z jego adresu w panelu: to część po
/dashboard/.
Każdy, kto zna identyfikator chatbota, może z nim rozmawiać z aplikacji, tak jak przez jego link do udostępnienia, więc chatbot powinien odpowiadać tylko na podstawie tego, co można pokazać publicznie.
Dodaj pakiet
W Xcode wybierz File > Add Package Dependencies, wpisz https://github.com/rouzbeh-abadi/chatfrom-ios, ustaw regułę na Up to Next Minor Version, bo przed wersją 1.0 nawet wersja minor może zmienić API, i dodaj do aplikacji bibliotekę ChatFromSDK. Albo w Package.swift:
Pokaż dymek
Jedna linijka przy starcie aplikacji, w application(_:didFinishLaunchingWithOptions:) albo w init() struktury App w SwiftUI:
- Dymek sam ustawia się nad paskiem kart i usuwa się na bok, gdy zasłania go klawiatura. Ekrany wyświetlane przez Twoją aplikację na wierzchu go zakrywają.
- Jeśli masz własny pasek, który pojawia się i znika, na przykład odtwarzacz albo minutnik,
ChatFrom.setBottomInset(_:)przesuwa dymek tak, żeby mu nie przeszkadzał. ChatFrom.setBubbleHidden(true)ukrywa go na ekranie, na którym by przeszkadzał, na przykład na Twoim własnym ekranie blokady albo ekranie pierwszego uruchomienia, aChatFrom.stop()usuwa go całkiem.- Chatbot, który na Twojej stronie pokazuje pasek do wpisywania pytań, w aplikacji i tak pokazuje dymek, zgodnie z ustawieniami dymka w sekcji Deploy.
Albo dodaj wiersz
W SwiftUI, w List lub Form:
W UIKit ChatFromCell to ten sam wiersz do widoku tabeli, a ChatFromButton do każdego innego miejsca. Żeby otworzyć czat z własnego elementu, na przykład pozycji menu, wywołaj ChatFrom.open(botId:). Wiersz jest szary, dopóki chatbot nie jest uruchomiony.
Zalogowani użytkownicy
Jeśli użytkownicy logują się w Twojej aplikacji, przekaż, kto z niej korzysta, żeby następna osoba na wspólnym urządzeniu nie zobaczyła czatu poprzedniej:
userIdto identyfikator tej osoby w Twojej aplikacji. Używany jest tylko jego odcisk cyfrowy, który pozostaje na urządzeniu.userTokenjest opcjonalny, dla chatbota, którego narzędzia działają w imieniu zalogowanego użytkownika, tak jak na Twojej stronie. Pobieraj go z własnego serwera i nigdy nie podpisuj go w aplikacji. Trafia tylko do serwerów narzędzi, które oznaczysz jako jego odbiorców.
Pytania o subskrypcje
Gdy w sekcji Tools jest połączony RevenueCat, klienci mogą pytać chatbota o swoją subskrypcję, od wersji 0.2.0 pakietu. Twoja aplikacja wskazuje, kto pyta: token z Twojego serwera jako opisany wyżej userToken, anonimowy identyfikator RevenueCat albo dane o subskrypcjach prosto z App Store.
Ustaw identyfikator RevenueCat ponownie, gdy tylko się zmieni. ChatFrom.logout() go zapomina, więc potem ustaw identyfikator kolejnego klienta. Przekazywane są tylko anonimowe identyfikatory RevenueCat: dla zalogowanego klienta użyj tokenu.
Co musi zrobić Twoja aplikacja
- Zgoda. Odpowiedzi pochodzą z modelu AI za pośrednictwem ChatFrom, więc to Ty odpowiadasz za spełnienie reguły App Review firmy Apple dotyczącej przekazywania danych osobowych do AI podmiotu trzeciego (wytyczna 5.1.2(i)): poinformuj o tym w aplikacji i uzyskaj zgodę, zanim ktoś po raz pierwszy skorzysta z czatu. Dymek i wiersze ładują stronę czatu i otwierają ją po dotknięciu, więc wywołaj
ChatFrom.startalbo pokaż wiersz dopiero wtedy, gdy masz tę zgodę. Żeby zapytać o nią w chwili dotknięcia, użyj własnego przycisku, który najpierw pyta, a potem wywołujeChatFrom.open(botId:). - Prywatność. Twoja informacja o prywatności musi obejmować to, co użytkownicy piszą do chatbota, i to, o co pytają jego narzędzia, na przykład imię, adres e-mail albo numer telefonu, żeby umówić rozmowę. Manifest prywatności SDK deklaruje te dane, a także historię zakupów, którą czat odczytuje, gdy udostępniasz subskrypcje z App Store. To, co czat przechowuje na urządzeniu, zależy od opcji Remember returning visitors w sekcji Deploy: gdy jest włączona, dane zostają między uruchomieniami aplikacji, a gdy jest wyłączona, tylko do jej zamknięcia.
- Aparat. Okno wyboru plików może zaproponować zrobienie zdjęcia, więc dodaj
NSCameraUsageDescriptiondo swojego plikuInfo.plist. - App-Bound Domains. Jeśli Twój plik
Info.plistzawiera listęWKAppBoundDomains, dodaj do niejchatfrom.io, bo inaczej czat się nie załaduje.
Odpowiedzi w aplikacji zużywają Twoje miesięczne kredyty, tak samo jak na Twojej stronie.
W pliku README SDK znajdziesz wszystkie wywołania i opcje. Jak umieścić tego samego chatbota na swojej stronie, opisuje przewodnik Pierwsze kroki.