NowChatOptions : iOS

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 2 minutes de lecture
  • La classe NowChatOptions vous permet de configurer des options, telles que l’affichage d’une invite avant la fermeture d’une fenêtre de messagerie instantanée ou la désactivation de fonctionnalités lors de l’utilisation de la messagerie instantanée, sur une session de messagerie instantanée.

    NowChatOptions : ClosePrompt(en-tête : String ?, message : String, acceptButtonTitle : String, declineButtonTitle : String)

    Crée et renvoie un objet ClosePrompt en fonction des paramètres passés. Vous transmettez ensuite cet objet dans la méthode NowChatOptions() pour configurer les options d’invite de fermeture dans une session de messagerie instantanée.

    Tableau 1. Paramètres
    Nom Type Description
    header Chaîne Texte à afficher dans l’en-tête de l’invite.

    Si vous ne souhaitez pas afficher d’en-tête d’invite, passez « nil ».

    message Chaîne Texte à afficher en tant que texte principal de l’invite.
    acceptButtonTitle Chaîne Texte à afficher sur le bouton primaire de l’invite pour fermer la fenêtre de messagerie instantanée.
    declineButtonTitle (en anglais seulement) Chaîne Texte à afficher sur le bouton secondaire de l’invite qui rejette l’invite.

    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
      }
    }

    NowChatOptions - NowChatOptions(closePrompt : ClosePrompt ?, disabledFeatures : [Feature] ?, forceNewConversation : Bool)

    Configure les options de la session de messagerie instantanée en cours. Cette méthode vous permet d’afficher une invite avant de fermer une fenêtre de messagerie instantanée, de désactiver des fonctionnalités lors de l’utilisation de la messagerie instantanée et de forcer une nouvelle conversation de messagerie instantanée au démarrage du service de messagerie instantanée.

    Tableau 2. Paramètres
    Nom Type Description
    closePrompt (en anglais seulement) Objet ClosePrompt Invite à afficher avant de fermer la fenêtre de messagerie instantanée associée.

    Si vous ne souhaitez pas afficher d’invite de fermeture, passez « néant ».

    disabledFeatures [Caractéristique] Liste des fonctionnalités de messagerie instantanée à désactiver dans la session de messagerie instantanée actuelle.
    Valeur valide :
    • startNewConversation : masquez/désactivez le bouton StartNew Conversation qui apparaît dans une fenêtre de messagerie instantanée.

    Les fonctionnalités de messagerie instantanée disponibles sont définies dans la classe d’énumération NowChatOptions.Feature .

    Si vous ne souhaitez désactiver aucune fonctionnalité, passez « nil ».

    forceNewConversation Booléen Marqueur indiquant s’il faut forcer une nouvelle conversation de messagerie instantanée au démarrage de la session de messagerie instantanée. Toutes les conversations en cours sont fermées.
    Valeurs valides :
    • true : démarrer une nouvelle conversation de messagerie instantanée ; Une nouvelle fenêtre de messagerie instantanée s’ouvre.
    • false : ne démarrez pas une nouvelle conversation de messagerie instantanée ; Utilisez la fenêtre de messagerie instantanée existante.

    Valeur par défaut : false

    Tableau 3. Renvoie
    Type Description
    options de messagerie instantanée Renvoie un objet chatOptions que vous pouvez transmettre dans la NowChatService : makeChatUI(theme : NowChatThemeable, chatOptions : NowChatOptions ? = nil) -> Result<UIViewController, NowChatServiceError>) méthode.

    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
      }
    }