Classe NowChatService : iOS

La classe NowChatService fournit des options virtuelles 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, lancer 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 Vancouver ou Xanadu. Type de données : chaîne
networkService (en anglais)	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é Identité empruntée Inconnu Type de données : SessionType

NowChatService : init(configuration : NowServiceConfiguration, delegate : NowChatServiceDelegate ?, coreServiceProvider : NowCoreServiceProviding ? = néant)

Initialise une nouvelle instance de NowChatService.

Tableau 2. Paramètres

Nom	Type	Description
configuration	NowServiceConfiguration	Informations de configuration nécessaires pour initialiser correctement le service.
délégué	NowChatServiceDelegate	Facultatif. Objet de délégué de rappel NowChat implémentant le protocole NowChatServiceDelegate. Valeur par défaut : néant
coreServiceProvider	NowCoreServiceProviding	Facultatif. Objet implémentant le protocole NowCoreServiceSupplying. Permet d’accéder aux services NowChat. Valeur par défaut : néant

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, chatConfiguration : NowChatConfiguration ? = 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 la messagerie instantanée, vous devez toujours lancer la session de messagerie instantanée en appelant la fonction startChat( ). Vous devez passer cet appel lorsque l’interface utilisateur de la messagerie instantanée devient visible. Pour en savoir plus, consultez l’exemple d’application associé et le Mobile SDK Guide du développeur : iOS.

Tableau 3. Paramètres

Nom	Type	Description
thème	Objet NowChatThemeable	Informations sur le thème de l’interface utilisateur de messagerie instantanée à créer.
chatConfiguration	Configuration de la messagerie instantanée ?	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 : chatServiceInvalid coreServiceInvalid guestUserNotAllowed Informations d’identification non valides noSession Inconnu serveur non supporté

L’exemple de code suivant montre comment appeler cette fonction pour créer l’interface utilisateur de la messagerie instantanée.

func makeChatScreen() -> UIViewController? {
  guard let chatService = chatService else { return nil } 

  let closePrompt = NowChatConfiguration.ClosePrompt(header: "Close Window",
    message: "Are you sure you want to close the chat window?",
    acceptButtonTitle: "Yes",
    declineButtonTitle: "No") 

  let attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible: false) // default isVisible = true

  let chatConfiguration = NowChatConfiguration(closePrompt: closePrompt,
    disabledFeatures: [.startNewConversation],
    conversationOptions: [.forceNewConversation, .endConversationOnExit],
    uiConfiguration: NowChatConfiguration.UIConfiguration(closeButton: closeButtonImage(name: "arrow.left"), attachmentUploadButton: attachmentUploadButton))

  let result = chatService.makeChatUI(theme: CarrascoChatTheme(chatColors: ChatColors()), chatConfiguration: chatConfiguration)    

  switch result {
    case .success(let chatViewController):
      return chatViewController
    case .failure(let error):
      debugPrint("Chat screen creation failed with error: \(error)") 
      return nil
  }
}

NowChatService : shutdown()

Ferme 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 de NowChatService en appelant la fonction NowChat.makeChatService( ).

Tableau 5. Paramètres

Nom	Type	Description
Aucun

Tableau 6. Renvoie

Type	Description
Néant

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] ? = nil, _ complétion : @escaping (Result<Void, NowChatServiceError>) -> Void)

Démarre une session de messagerie instantanée et exécute un bloc de complétion après le démarrage de la session de messagerie instantanée.

Tableau 7. Paramètres

Nom	Type	Description
données contextuelles	[chaîne : n’importe lequel] ?	Facultatif. Dictionnaire contenant des variables de contexte de messagerie instantanée transmises à la session de messagerie instantanée. Pour plus d’informations sur les variables de contexte de messagerie instantanée, reportez-vous à la section Live agent chat context variables.
achèvement	Objet	Bloc d’achèvement à exécuter une fois la session de messagerie instantanée démarrée.

Tableau 8. Renvoie

Type	Description
void ou chaîne	Valeurs renvoyées pour le bloc de complétion : Réussite : nul Erreur : NowChatServiceError Erreurs possibles : chatServiceInvalid coreServiceInvalid guestUserNotAllowed Informations d’identification non valides noSession Inconnu serveur non supporté

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

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 du nombre de messages non lus.

Tableau 9. 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) > Vide)	Gestionnaire d’achèvement à appeler pour signaler le nombre de messages de messagerie instantanée non lus. Int: nombre de messages de messagerie instantanée non lus.

Tableau 10. Renvoie

Type	Description
Néant

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 du nombre de messages non lus de l’écouteur.

Tableau 11. Paramètres

Nom	Type	Description
Aucun

Tableau 12. Renvoie

Type	Description
Néant

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
}