Package com.zendesk.sdk.support
Class SupportActivity
- java.lang.Object
-
- AppCompatActivity
-
- com.zendesk.sdk.support.SupportActivity
-
- All Implemented Interfaces:
- SupportMvp.View
public class SupportActivity extends AppCompatActivity implements SupportMvp.View
This Activity is the main entry point for showing Help Center content in the SDK.This Activity is designed to be started with the
SupportActivity.Builder
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
SupportActivity.Builder
This builder is used to generate the startup configuration for the Activity.
-
Constructor Summary
Constructors Constructor and Description SupportActivity()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description void
clearSearchResults()
Clears any currently shown search results from the view.void
dismissError()
Dismiss the error Snackbar if it is currently displayed.void
exitActivity()
Exits the activity immediatelyContext
getContext()
Gets the View's context.void
hideLoadingState()
Hides the loading stateboolean
isShowingHelp()
Tells whether the view is currently showing the Help Center, or Search results.protected void
onCreate(Bundle savedInstanceState)
boolean
onCreateOptionsMenu(Menu menu)
boolean
onOptionsItemSelected(MenuItem item)
protected void
onPause()
boolean
onPrepareOptionsMenu(Menu menu)
protected void
onResume()
protected void
onSaveInstanceState(Bundle outState)
void
showContactUsButton()
Shows the contact us button as a FABvoid
showContactZendesk()
Shows the contact Zendesk componentvoid
showError(int errorMessageId)
Shows a Snackbar with an error messagevoid
showErrorWithRetry(SupportMvp.ErrorType errorType, RetryAction action)
Shows a snackbar with an error message and a retry actionvoid
showHelp(SupportUiConfig supportUiConfig)
Shows Help for the given SDK UI configuration.void
showLoadingState()
Shows a loading statevoid
showRequestList()
Shows the list of requests that the user has createdvoid
showSearchResults(java.util.List<SearchArticle> searchArticles, java.lang.String query)
Shows Help search results for the given query text
-
-
-
Method Detail
-
onCreate
protected void onCreate(Bundle savedInstanceState)
-
onResume
protected void onResume()
-
onPause
protected void onPause()
-
onCreateOptionsMenu
public boolean onCreateOptionsMenu(Menu menu)
-
onPrepareOptionsMenu
public boolean onPrepareOptionsMenu(Menu menu)
-
onOptionsItemSelected
public boolean onOptionsItemSelected(MenuItem item)
-
showContactUsButton
public void showContactUsButton()
Description copied from interface:SupportMvp.View
Shows the contact us button as a FAB- Specified by:
showContactUsButton
in interfaceSupportMvp.View
-
showHelp
public void showHelp(SupportUiConfig supportUiConfig)
Description copied from interface:SupportMvp.View
Shows Help for the given SDK UI configuration.- Specified by:
showHelp
in interfaceSupportMvp.View
- Parameters:
supportUiConfig
- The SupportUiConfig containing the category and section IDs, label names, and configuration flags to be used in displaying the UI.
-
showLoadingState
public void showLoadingState()
Description copied from interface:SupportMvp.View
Shows a loading state- Specified by:
showLoadingState
in interfaceSupportMvp.View
-
hideLoadingState
public void hideLoadingState()
Description copied from interface:SupportMvp.View
Hides the loading state- Specified by:
hideLoadingState
in interfaceSupportMvp.View
-
showSearchResults
public void showSearchResults(java.util.List<SearchArticle> searchArticles, java.lang.String query)
Description copied from interface:SupportMvp.View
Shows Help search results for the given query text- Specified by:
showSearchResults
in interfaceSupportMvp.View
- Parameters:
searchArticles
- The List of articles returned for the searchquery
- The query text that was used in the search
-
clearSearchResults
public void clearSearchResults()
Description copied from interface:SupportMvp.View
Clears any currently shown search results from the view.- Specified by:
clearSearchResults
in interfaceSupportMvp.View
-
isShowingHelp
public boolean isShowingHelp()
Description copied from interface:SupportMvp.View
Tells whether the view is currently showing the Help Center, or Search results. While this is the kind of logical decision normally calculated by the presenter, in this case, with state changes etc, the view is the ultimate source of truth.- Specified by:
isShowingHelp
in interfaceSupportMvp.View
- Returns:
- true if the currently displayed view is the Help Center, false if it's search results.
-
showRequestList
public void showRequestList()
Description copied from interface:SupportMvp.View
Shows the list of requests that the user has created- Specified by:
showRequestList
in interfaceSupportMvp.View
-
showContactZendesk
public void showContactZendesk()
Description copied from interface:SupportMvp.View
Shows the contact Zendesk component- Specified by:
showContactZendesk
in interfaceSupportMvp.View
-
showErrorWithRetry
public void showErrorWithRetry(SupportMvp.ErrorType errorType, RetryAction action)
Description copied from interface:SupportMvp.View
Shows a snackbar with an error message and a retry action- Specified by:
showErrorWithRetry
in interfaceSupportMvp.View
- Parameters:
errorType
- The type of error to display a message foraction
- The retry action to perform
-
showError
public void showError(int errorMessageId)
Description copied from interface:SupportMvp.View
Shows a Snackbar with an error message- Specified by:
showError
in interfaceSupportMvp.View
- Parameters:
errorMessageId
- The string resource ID to display
-
dismissError
public void dismissError()
Description copied from interface:SupportMvp.View
Dismiss the error Snackbar if it is currently displayed.- Specified by:
dismissError
in interfaceSupportMvp.View
-
getContext
public Context getContext()
Description copied from interface:SupportMvp.View
Gets the View's context.- Specified by:
getContext
in interfaceSupportMvp.View
- Returns:
- The Context of the View implementation.
-
onSaveInstanceState
protected void onSaveInstanceState(Bundle outState)
-
exitActivity
public void exitActivity()
Description copied from interface:SupportMvp.View
Exits the activity immediately- Specified by:
exitActivity
in interfaceSupportMvp.View
-
-