NowChatConfiguration - Android

NowChatConfiguration 클래스를 사용하면 채팅 창을 닫기 전에 프롬프트 표시, 채팅 사용 중 기능 비활성화, 채팅 사용 시 다른 대화 옵션 적용, NowChat에서 UI 구성 요소 구성 등 채팅 세션의 옵션을 구성할 수 있습니다.

NowChatConfiguration - NowChatConfiguration(closePrompt: ClosePrompt? = null, disabledFeatures: List<Feature>? = null, conversationOptions: List<ConversationOption>? = null, uiConfiguration: UIConfiguration? = null)

현재 채팅 세션에 대한 옵션을 구성합니다. 이 방법을 사용하면 채팅 창을 닫기 전에 프롬프트를 표시하고, 채팅을 사용하는 동안 기능을 비활성화하고, 채팅을 사용할 때 다른 대화 옵션을 적용하고, NowChat에서 UI 구성요소를 구성할 수 있습니다.

표 1. 매개변수

이름	유형	설명
close프롬프트	ClosePrompt 객체	연결된 채팅 창을 닫기 전에 표시할 프롬프트 NowChatConfiguration.ClosePrompt() 서브클래스를 호출하여 이 파라미터의 값을 정의합니다. 예: closePrompt = NowChatConfiguration.ClosePrompt( header = null, message = "Are you sure you want to leave?", acceptButtonTitle = "Yes", declineButtonTitle = "No" ) 닫기 프롬프트를 표시하지 않으려면 null을 전달합니다.
비활성화된 기능	List<NowChatConfiguration을 입력합니다. 특징>	현재 채팅 세션에서 비활성화할 채팅 기능 목록입니다. 유효한 값: START_NEW_CONVERSATION: 채팅 창에 나타나는 새 대화 시작 단추를 숨기거나 사용하지 않도록 설정합니다. 사용 가능한 채팅 기능은 NowChatConfiguration.Feature 열거형 클래스에 정의되어 있습니다. 예: disabledFeatures = listOf(NowChatConfiguration.Feature.START_NEW_CONVERSATION) 기능을 비활성화하지 않으려면 null을 전달합니다.
대화 옵션	목록<대화 옵션>?	NowChat에 적용할 대화 옵션 목록입니다. 유효한 값은 다음과 같습니다. END_CONVERSATION_ON_EXIT: NowChat 창을 종료하면 진행 중인 대화가 종료됩니다. FORCE_NEW_CONVERSATION: NowChat이 시작될 때 새 채팅 대화를 강제 적용합니다. 사용 가능한 대화 옵션은 NowChatConfiguration.ConversationOption 열거형 클래스에 정의되어 있습니다. 예: conversationOptions = listOf(NowChatConfiguration.ConversationOption.FORCE_NEW_CONVERSATION), 옵션을 적용하지 않으려면 null을 전달합니다.
ui구성	UIConfiguration?	NowChat에서 UI 구성요소를 구성하는 데 사용할 UIConfiguration 값입니다. 유효한 값은 다음과 같습니다. attachmentUploadButton: 라이브 에이전트와 대화하는 동안 텍스트 입력 옆에 표시되는 AttachmentUploadButton 에 대한 구성입니다. closeButton: NowChat 도구 모음에서 뒤로 탐색에 사용되는 CloseButton 에 대한 구성입니다. 예: uiConfiguration = NowChatConfiguration.UIConfiguration( closeButton = NowChatConfiguration.CloseButton( icon = myDrawable ), attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false) ) 기본 구성을 사용하려면 null을 전달합니다.

표 2. 반환

유형	설명
NowChat구성	메서드를 호출할 NowChatService - start(activity: Activity, themeColors: NowChatTheme = object: NowChatTheme{}, contextData: map<String, any> = mapOf(), chatConfiguration: NowChatConfiguration? = null) 때 전달할 수 있는 NowChatConfiguration 객체를 반환합니다.

다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다.

suspend fun launchChat() {
  val chatService = getNowChatService()
 
  //Drawable to use instead of the default NowChat back button.
  val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)
     
  val chatConfiguration = NowChatConfiguration(
    closePrompt = NowChatConfiguration.ClosePrompt(
      header = null,
      message = "Are you sure you want to leave?",
      acceptButtonTitle = "Yes",
      declineButtonTitle = "No"
    ),
    disabledFeatures = listOf(NowChatConfiguration.Feature.START_NEW_CONVERSATION),
    conversationOptions = listOf(NowChatConfiguration.ConversationOption.FORCE_NEW_CONVERSATION),
    uiConfiguration = NowChatConfiguration.UIConfiguration(
      closeButton = NowChatConfiguration.CloseButton(
        icon = myDrawable
      ),
      attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
    )
  )

  chatService?.start(activity, chatConfiguration)
}

NowChatConfiguration - AttachmentUploadButton(isVisible: 부울 = true)

라이브 에이전트와 대화하는 동안 텍스트 입력 옆에 나타나는 첨부 파일 업로드 버튼에 적용할 UI 구성을 정의합니다.

AttachmentUploadButton 은 NowChatConfiguration 클래스의 하위 클래스입니다.

표 3. 매개변수

이름	유형	설명
isVisible	부울	첨부 파일 업로드 버튼의 가시성을 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 첨부 파일 업로드 버튼이 표시됩니다. 아니오: 첨부 파일 업로드 버튼이 숨겨져 있습니다. 기본값: true

표 4. 반환

유형	설명
객체	UI 구성 객체입니다.

다음 코드 예제에서는 AttachmentUploadButton을 숨기는 방법을 보여 줍니다.

suspend fun launchChat() {
  val chatService = getNowChatService()

  val chatConfiguration = NowChatConfiguration(
    uiConfiguration = NowChatConfiguration.UIConfiguration(
      attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
    )
  )
 
  chatService?.start(activity, chatConfiguration)
}

NowChatConfiguration - CloseButton(아이콘: Drawable?)

NowChat 도구 모음에서 뒤로 탐색에 사용되는 닫기 버튼의 구성을 정의합니다. 그런 다음 이 객체를 NowChatConfiguration() 메서드에 전달하여 채팅 세션 내에서 사용할 닫기 버튼을 구성합니다.

CloseButton() 은 NowChatConfiguration 클래스의 서브클래스입니다.

표 5. 매개변수

이름	유형	설명
아이콘	드로어블?	닫기(뒤로) 단추에 사용할 그리기 가능한 객체입니다. ContextCompat.getDrawable() 메서드를 사용하여 이 드로어블 객체를 가져올 수 있습니다. 예: val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable) 기본 드로어블을 사용하려면 null을 전달합니다. 기본값: NowChat 뒤로 버튼

표 6. 반환

유형	설명
객체	닫기 버튼 구성 객체입니다.

다음 코드 예제는 NowChat 도구 모음에서 닫기 버튼에 대한 사용자 지정 아이콘을 설정하는 방법을 보여줍니다.

suspend fun launchChat() {
  val chatService = getNowChatService()
 
  //Drawable to use instead of the default NowChat back button.
  val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)

  val chatConfiguration = NowChatConfiguration(
    uiConfiguration = NowChatConfiguration.UIConfiguration(
      closeButton = NowChatConfiguration.CloseButton(
        icon = myDrawable
      )
    )
  )

  chatService?.start(activity, chatConfiguration)
}

NowChatConfiguration - ClosePrompt(헤더: 문자열, 메시지: 문자열, acceptButtonTitle: 문자열, declineButtonTitle: 문자열)

전달된 매개변수를 기반으로 ClosePrompt 객체를 만들고 반환합니다. 그런 다음 이 객체를 NowChatConfiguration() 메서드에 전달하여 채팅 세션 내에서 프롬프트 닫기 옵션을 구성합니다.

표 7. 매개변수

이름	유형	설명
헤더	문자열	프롬프트의 헤더에 표시할 텍스트입니다. 프롬프트 헤더를 표시하지 않으려면 null을 전달합니다.
메시지	문자열	프롬프트의 메인 텍스트로 표시할 텍스트입니다.
acceptButtonTitle	문자열	채팅 창을 닫기 위한 프롬프트의 기본 버튼에 표시할 텍스트입니다.
거부버튼 제목	문자열	프롬프트를 해제하는 프롬프트의 보조 버튼에 표시할 텍스트입니다. 보조 단추를 표시하지 않으려면 null을 전달합니다.

표 8. 반환

유형	설명
객체	연결된 채팅 창을 닫기 전에 표시할 프롬프트

다음 코드 예제에서는 이 메서드를 호출하여 닫기 프롬프트를 구성하는 방법을 보여 줍니다.

suspend fun launchChat() {
  val chatService = getNowChatService()
 
  val chatConfiguration = NowChatConfiguration(
    closePrompt = NowChatConfiguration.ClosePrompt(
      header = null,
      message = "Are you sure you want to leave?",
      acceptButtonTitle = "Yes",
      declineButtonTitle = "No"
    )
  )
  chatService?.start(activity, chatConfiguration)
}

NowChatConfiguration - UIConfiguration(closeButton: CloseButton? = null, attachmentUploadButton: AttachmentUploadButton? = null)

전달된 매개변수를 기반으로 UIConfiguration 객체를 만들고 반환합니다. 그런 다음 이 객체를 NowChatConfiguration() 생성자에 전달하여 NowChat에서 UI 구성요소를 구성합니다.

UIConfiguration 은 NowChatConfiguration 클래스의 서브클래스입니다.

표 9. 매개변수

이름	유형	설명
닫기버튼	닫기 버튼?	NowChat 도구 모음에 나타나고 뒤로 탐색에 사용되는 CloseButton 에 대한 구성입니다. NowChatConfiguration - CloseButton(아이콘: Drawable?) 서브클래스를 호출하여 이 매개변수의 값을 정의합니다. 예: val chatConfiguration = NowChatConfiguration( uiConfiguration = NowChatConfiguration.UIConfiguration( closeButton = NowChatConfiguration.CloseButton( icon = myDrawable ) )
첨부 파일 업로드 버튼	첨부 파일 업로드 버튼?	라이브 에이전트와 대화하는 동안 텍스트 입력 옆에 표시되는 AttachmentUploadButton 에 대한 구성입니다. NowChatConfiguration - AttachmentUploadButton(isVisible: 부울 = true) 서브클래스를 호출하여 이 매개변수의 값을 정의합니다. 예: val chatConfiguration = NowChatConfiguration( uiConfiguration = NowChatConfiguration.UIConfiguration( attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false) ) )

표 10. 반환

유형	설명
객체	UI 구성 객체입니다.

다음 코드 예제에서는 UIConfiguration 하위 클래스를 호출하여 closeButton의 아이콘을 설정하고 첨부 파일 업로드 단추를 숨기는 방법을 보여 줍니다.

suspend fun launchChat() {
  val chatService = getNowChatService() 
     
  //Drawable to use instead of the default NowChat back button. 
  val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable) 
 
  val chatConfiguration = NowChatConfiguration( 
    uiConfiguration = NowChatConfiguration.UIConfiguration( 
      closeButton = NowChatConfiguration.CloseButton( 
        icon = myDrawable 
      ), 
      attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
    ) 
  ) 
 
  chatService?.start(activity, chatConfiguration) 
}