Classe NowChatService : iOS

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 6 minutes de lecture

    • La classe NowChatService fournit des options de messagerie virtuelle et Agent actif de messagerie instantanée.

    À l’aide de cette classe, vous pouvez démarrer et arrêter des services de messagerie instantanée, démarrer des sessions de messagerie instantanée, créer une interface utilisateur de messagerie instantanée et vous abonner ou vous désabonner de messages non lus.

    Tableau 1. Propriétés
    Nom Description
    configuration Paramètres de configuration fournis lors de l’initialisation du service.

    Type de données : NowServiceConfiguration
    instanceVersion Version de l’instance associée ServiceNow , par exemple Utah ou Quebec.

    Type de données : chaîne
    networkService Service réseau associé à ce service de messagerie instantanée.

    Type de données : NetworkService
    Type de session Type de session.
    Valeurs possibles :
    • Authentifié
    • Invités
    • Identité empruntée
    • Inconnu

    Type de données : SessionType

    NowChatService : init(configuration : NowServiceConfiguration, delegate : NowChatServiceDelegate ?, coreServiceProvider : NowCoreServiceProviding ? = nil)

    Initialise une nouvelle instance NowChatService.

    Tableau 2. Paramètres
    Nom Type Description
    configuration Configuration Now ServiceConfiguration Informations de configuration nécessaires pour initialiser correctement le service.
    délégué NowChatServiceDelegate Facultatif. Objet délégué de rappel NowChat implémentant le protocole NowChatServiceDelegate.

    Par défaut : nul
    coreServiceProvider (en anglais seulement) NowCoreServiceProviding Facultatif. Objet implémentant le protocole NowCoreServiceProviding Permet d’accéder aux services Now Chat.

    Par défaut : nul

    L’exemple de code suivant montre comment appeler cette fonction.

    guard let coreService = NowSDK.core() else {
  // Error with NowServiceError.sdkNotConfigured
  return
}

guard 
  let instanceUrl = URL(string: "http://sample.service-now.com"), 
  let serviceConfig = NowSDK.makeServiceConfiguration(for: instanceUrl) else {
    // Could not create service – 
    // NowServiceError.serviceConfigurationInvalid
    return
  }
    
let chatService = NowChatService(configuration: serviceConfig, delegate: delegate, coreServiceProvider: coreService)

    NowChatService : makeChatUI(theme : NowChatThemeable, chatOptions : NowChatOptions ? = nil) -> Result<UIViewController, NowChatServiceError>)

    Crée un UIViewController qui héberge l’interface utilisateur de la messagerie instantanée.

    Bien que cette fonction crée l’interface utilisateur de messagerie instantanée, vous devez toujours lancer la session de messagerie instantanée en appelant la fonction startChat(). Vous devez effectuer cet appel au fur et à mesure que l’interface utilisateur de la messagerie instantanée devient visible. Pour plus d’informations, consultez l’exemple d’application associé et le Mobile SDK Guide du développeur - iOSfichier .

    Tableau 3. Paramètres
    Nom Type Description
    thème Objet NowChatThemeable Informations de thème pour l’interface utilisateur de messagerie instantanée à créer.
    options de messagerie instantanée NowChatOptions ? Facultatif. Options à appliquer à la session de messagerie instantanée.
    Tableau 4. Renvoie
    Type Description
    Objet Réussite : objet UIViewController qui contient les informations de configuration du contrôleur de vue d’interface utilisateur.

    Échec : objet NowChatServiceError.

    Erreurs possibles :
    • messagerie instantanéeServiceNon valide
    • coreServiceInvalid
    • guestUserNotAllowed
    • invalidCredentials (Informations d’identification invalides)
    • noSession (en anglais seulement)
    • Inconnu
    • unsupportedServer

    L’exemple de code suivant montre comment appeler cette fonction.

    func makeChatScreen() -> UIViewController? {
  guard let chatService = chatService else { return nil }
  let closePrompt = NowChatOptions.ClosePrompt(
    header: "Close Window",
    message: "Are you sure you want to close the chat window?",
    acceptButtonTitle: "Yes",
    declineButtonTitle: "No")

  let disabledFeatures = [.startNewConversation]
    
  let chatOptions = NowChatOptions(closePrompt: closePrompt,
    disabledFeatures: disabledFeatures,
    forceNewConversation: true)
    
  let result = chatService.makeChatUI(theme: CarrascoChatTheme(chatColors: ChatColors()), chatOptions: chatOptions)
    
  switch result {
  case .success(let chatViewController):
    return chatViewController
  case .failure(let error):
    return nil
  }
}

    NowChatService : shutdown()

    Arrête le service de messagerie instantanée, y compris toutes les sessions de messagerie instantanée actives.

    Après l’appel de cette fonction, le NowChatService associé est inactif et ne peut pas être réutilisé. Pour établir une autre session de messagerie instantanée, créez une nouvelle instance NowChatService en appelant la fonction NowChat.makeChatService().

    Tableau 5. Paramètres
    Nom Type Description
    Aucun
    Tableau 6. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction.

    private func resetChat() {
  chatService?.shutdown()
  chatService = nil
  initializeChatService()
  viewState = makeViewState()
}

func initializeChatService() {
  NowChat.makeChatService(instanceUrl: instanceUrl, delegate: self) { [weak self] result in
    guard let self = self else { return }
            
    switch result {
    case .success(let service):
      self.chatService = service
    case .failure(let error):
      debugPrint("Creating the chat service failed with error: \(error)")
    }
    self.viewState = self.makeViewState()
}

func makeViewState() -> ViewState {
  ViewState(chatEnabled: chatService != nil,
    menuItems: menuItems)
}

    NowChatService : startChat(contextData : [String : Any] ?)

    Démarre une session de messagerie instantanée.

    Remarque :
    Si vous souhaitez exécuter une tâche de complétion après le démarrage de la session de chat, utilisez la NowChatService : startChat(contextData : [String : Any] ? = nil, _ completion : @escaping (Result<Void, NowChatServiceError>)) fonction.
    Tableau 7. Paramètres
    Nom Type Description
    contextData [chaîne : n’importe laquelle] ? Facultatif. Dictionnaire contenant des variables de contexte de messagerie instantanée transmises dans la session de messagerie instantanée.

    Pour en savoir plus sur les variables de contexte de la messagerie instantanée, reportez-vous à la section Live agent chat context variables.
    Tableau 8. Renvoie
    Type Description
    void ou String Réussite : nul

    Erreur : NowChatServiceError

    Erreurs possibles :
    • messagerie instantanéeServiceNon valide
    • coreServiceInvalid
    • guestUserNotAllowed
    • invalidCredentials (Informations d’identification invalides)
    • noSession (en anglais seulement)
    • Inconnu
    • unsupportedServer

    L’exemple de code suivant montre comment appeler cette fonction sans transmettre de variables de contexte.

    chatService.startChat { [weak self] result in
  if case .failure(let error) = result {
    debugPrint("Chat session initialization failed with error: \(error)")
    self?.resetChat()
  }
}

    L’exemple de code suivant montre comment appeler cette fonction en transmettant des variables de contexte.

    chatService.startChat { [weak self] result in
  let contextData = ["sys_id": "123456789", "table_name": "wm_task", "active": true] as [String: Any]
  chatService.startChat(contextData: contextData) { [weak self] result in
    if case .failure(let error) = result {
      debugPrint("Chat session initialization failed with error: \(error)")
      self?.resetChat()
    }
  }
}

    NowChatService : startChat(contextData : [String : Any] ? = nil, _ completion : @escaping (Result<Void, NowChatServiceError>))

    Démarre une session de messagerie instantanée et exécute un bloc de complétion une fois que la session de messagerie instantanée a démarré.

    Tableau 9. Paramètres
    Nom Type Description
    contextData [chaîne : n’importe laquelle] ? Facultatif. Dictionnaire contenant des variables de contexte de messagerie instantanée transmises dans la session de messagerie instantanée.

    Pour en savoir plus sur les variables de contexte de la messagerie instantanée, reportez-vous à la section Live agent chat context variables.
    achèvement Objet Bloc de complétion à exécuter une fois que la session de messagerie instantanée a démarré.
    Tableau 10. Renvoie
    Type Description
    void ou String
    Valeurs de retour pour le bloc de complétion :
    • Réussite : nul
    • Erreur : NowChatServiceError
    Erreurs possibles :
    • messagerie instantanéeServiceNon valide
    • coreServiceInvalid
    • guestUserNotAllowed
    • invalidCredentials (Informations d’identification invalides)
    • noSession (en anglais seulement)
    • Inconnu
    • unsupportedServer

    L’exemple de code suivant montre comment appeler cette fonction sans données de contexte.

    func startChat() {
  guard let chatService = chatService else {
    debugPrint("Chat service is invalid")
    viewState = makeViewState()
    return
  }
  chatService.startChat { [weak self] result in
    if case .failure(let error) = result {
      debugPrint("Chat session initialization failed with error: \(error)")
      self?.resetChat()
    }
  }
}

func makeViewState() -> ViewState {
  ViewState(chatEnabled: chatService != nil,
    menuItems: menuItems)
}

    L’exemple de code suivant montre comment appeler cette fonction avec des données de contexte.

    func startChat() {
  guard let chatService = chatService else {
    debugPrint("Chat service is invalid")
    viewState = makeViewState()
    return
  }

  let contextData = ["sys_id": "123456789", "table_name": "wm_task", "active": true] as [String: Any]
  chatService.startChat(contextData: contextData) { [weak self] result in
    if case .failure(let error) = result {
      debugPrint("Chat session initialization failed with error: \(error)")
      self?.resetChat()
    }
  }
}

func makeViewState() -> ViewState {
  ViewState(chatEnabled: chatService != nil,
    menuItems: menuItems)
}

    NowChatService : subscribeToUnreadMessageCount(pollingInterval : TimeInterval, completion : @escaping (Int) -> Void)

    S’abonne à l’écouteur de nombre de messages non lus.

    Tableau 11. Paramètres
    Nom Type Description
    intervalle d’interrogation Intervalle de temps Fréquence à laquelle interroger le service Web pour le nombre de messages de messagerie instantanée non lus.

    Unité : Secondes
    achèvement @escaping (int) -> nul) Gestionnaire de complétion à appeler pour signaler le nombre de messages de messagerie instantanée non lus.

    Int: nombre de messages de messagerie instantanée non lus.
    Tableau 12. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction.

    …
if viewModel.isPolling {
  viewModel.unsubscribeFromUnreadMessageCount()
  viewState.pollingInterval = ""
} else {
  viewModel.subscribeToUnreadMessageCount(pollingInterval: timeInterval)
}
…

func subscribeToUnreadMessageCount(pollingInterval: TimeInterval) {
  chatService.subscribeToUnreadMessageCount(pollingInterval: pollingInterval) { [weak self] count in
    self?.unreadMessageCount = count
  }
  isPolling = true
}

    NowChatService : unsubscribeFromUnreadMessageCount()

    Se désabonne de la réception de l’écouteur de nombre de messages non lus.

    Tableau 13. Paramètres
    Nom Type Description
    Aucun
    Tableau 14. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction.

    …
if viewModel.isPolling {
  viewModel.unsubscribeFromUnreadMessageCount()
  viewState.pollingInterval = ""
} else {
  viewModel.subscribeToUnreadMessageCount(pollingInterval: timeInterval)
}
…
func unsubscribeFromUnreadMessageCount() {
  chatService.unsubscribeFromUnreadMessageCount()
  isPolling = false
  unreadMessageCount = 0
}