Android Inline Inquiries Guide

1
val inlineInquiryFragment = Inquiry
2
    .fromTemplate(TEMPLATE_ID)
3
    .environment(Environment.SANDBOX)
4
    .toInlineInquiryBuilder()
5
    .createFragment()

1
// Inside an Activity
2
override fun onCreate(savedInstanceState: Bundle?) {
3
    // Guard against attaching the fragment multiple times.
4
    if (savedInstanceState == null) {
5
        supportFragmentManager.commit {
6
            replace(
7
                R.layout.inquiry_fragment_container,
8
                requireNotNull(inlineInquiryFragment),
9
            )
10
        }
11
    }
12
}
13
14
// Inside a Fragment
15
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
16
    // Guard against attaching the fragment multiple times.
17
    if (savedInstanceState == null) {
18
        childFragmentManager.commit {
19
            replace(
20
                R.layout.inquiry_fragment_container,
21
                requireNotNull(inlineInquiryFragment),
22
            )
23
        }
24
    }
25
}

1
// Inside an Activity
2
override fun onCreate(savedInstanceState: Bundle?) {
3
    // Listen for results from the Persona inquiry. By default the inquiry fragment uses
4
    // com.withpersona.sdk2.inquiry.types.DEFAULT_REQUEST_KEY as the request key to return
5
    // results to. This can be changed in the InlineInquiryBuilder.
6
    supportFragmentManager
7
        .setFragmentResultListener(DEFAULT_REQUEST_KEY, this) { _, bundle ->
8
            val result = Inquiry.extractInquiryResponseFromBundle(bundle, this)
9
10
            when (result) {
11
                is InquiryResponse.Cancel -> {
12
                    // User cancelled the flow.
13
                }
14
                is InquiryResponse.Complete -> {
15
                    // User completed the flow. Note that this doesn't mean the user
16
                    // verified successfully. It just means the user got to the end.
17
                }
18
                is InquiryResponse.Error -> {
19
                    // An error prevented the user from completing the flow.
20
                }
21
            }
22
        }
23
}
24
25
// Inside a Fragment
26
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
27
    // Listen for results from the Persona inquiry. By default the inquiry fragment uses
28
    // com.withpersona.sdk2.inquiry.types.DEFAULT_REQUEST_KEY as the request key to return
29
    // results to. This can be changed in the InlineInquiryBuilder.
30
    childFragmentManager
31
        .setFragmentResultListener(DEFAULT_REQUEST_KEY, viewLifecycleOwner) { _, bundle ->
32
            val result = Inquiry.extractInquiryResponseFromBundle(bundle, requireContext())
33
34
            when (result) {
35
                is InquiryResponse.Cancel -> {
36
                    // User cancelled the flow.
37
                }
38
                is InquiryResponse.Complete -> {
39
                    // User completed the flow. Note that this doesn't mean the user
40
                    // verified successfully. It just means the user got to the end.
41
                }
42
                is InquiryResponse.Error -> {
43
                    // An error prevented the user from completing the flow.
44
                }
45
            }
46
        }
47
}

1
// If using an Activity
2
// Have the hosting Activity implement InlineInquiryController
3
@OptIn(ExperimentalInlineApi::class)
4
class MyActivity : AppCompatActivity(), InlineInquiryController {
5
    private var inlineInquiryScreen: InlineInquiryScreen? = null
6
    
7
    @ExperimentalInlineApi
8
    override fun onAttached(inlineInquiryScreen: InlineInquiryScreen) {
9
        this.inlineInquiryScreen = inlineInquiryScreen
10
    }
11
12
    @ExperimentalInlineApi
13
    override fun onDetached() {
14
        this.inlineInquiryScreen = null
15
    }
16
}
17
18
// If using a Fragment
19
// Have the hosting Fragment implement InlineInquiryController
20
@OptIn(ExperimentalInlineApi::class)
21
class MyFragment : Fragment(), InlineInquiryController {
22
    private var inlineInquiryScreen: InlineInquiryScreen? = null
23
    
24
    @ExperimentalInlineApi
25
    override fun onAttached(inlineInquiryScreen: InlineInquiryScreen) {
26
        this.inlineInquiryScreen = inlineInquiryScreen
27
    }
28
29
    @ExperimentalInlineApi
30
    override fun onDetached() {
31
        this.inlineInquiryScreen = null
32
    }
33
}

1
backButton.setOnClickListener {
2
  inlineInquiryScreen?.goBack()
3
}
4
closeButton.setOnClickListener {
5
  inlineInquiryScreen?.cancelInquiry(force = false)
6
}

1
viewLifecycleOwner.lifecycleScope.launch {
2
    inlineInquiryScreen.screenStateFlow.collect {
3
        if (!it.isNavigationEnabled) {
4
          closeButton.isEnabled = false
5
          closeButton.alpha = 0.5f
6
          
7
          backButton.isEnabled = false
8
          backButton.alpha = 0.5f
9
        } else {
10
          closeButton.isEnabled = true
11
          closeButton.alpha = 1f
12
          
13
          backButton.isEnabled = true
14
          backButton.alpha = 1f
15
        }
16
        
17
        if (it.shouldShowBackButton) {
18
          backButton.visibility = View.VISIBLE
19
        } else {
20
          backButton.visibility = View.GONE
21
        }
22
23
        if (it.shouldShowCancelButton) {
24
          closeButton.visibility = View.VISIBLE
25
        } else {
26
          closeButton.visibility = View.GONE
27
        }
28
    }
29
}