Skip to content

Support UI Components

Ryan Matthew Pierson edited this page Jun 18, 2020 · 4 revisions

This page summarizes the out-of-the-box user interface (UI) components included with the Community Android SDK's lia-ui module. For an overview of our API, see API providers. See Javadoc for additional details.

Note: All fragments and activities respect the permissions assigned to the user in context based on their role(s) in Community. The Support UI components will not display content or allow actions not granted to the user.

Activities

Fragments

Activities

The SDK provides the following default activities. All activities are included in the lia-ui module.

Note: Our Login component (LiLoginActivity) is included in the lia-core package.

LiSupportHomeActivity

This is the main entry point for Community Support UI actions. The activity includes a header with search, an options menu, and two tabs. The Articles tab includes a navigation component to browse community categories and boards, message post actions, and recent messages posted to the community in descending order. The My Activities tab displays messages posted by the user, as well messages from the user's subscriptions, messages the user kudoed or selected as a solution.

Layout file: li_activity_support.xml

LiMessageListActivity

Displays a list of articles for the current board. Includes a button to launch the LiCreateMessageActivity.

Layout file: li_activity_articles.xml

LiConversationActivity

Displays the message thread. Includes author and message data, including kudos count and accepted solution status. Users can kudo messages, accept solutions, reply or comment, and share the message.

Layout file: li_activity_messages.xml

LiCreateMessageActivity

Creates a post form to create a message. The user can select the board to post to, if different than the current board in context. Image upload is supported. After posting the message, the user the My Activities tab in the LiSupportHome activity displays.

Layout file: li_activity_ask_question.xml

LiBrowseActivity

Creates a browse mechanism to navigate through the community structure. The user can begin a search by tapping an icon in the header.

Layout file: li_activity_browse.xml

LiSearchActivity

Creates a keyword search interaction and displays search results. Tapping on a result starts the LiMessageActivity.

Layout file: li_activity_search.xml

Fragments

The SDK includes the following fragments. You can use these fragments with our out-of-the-box activities or independently in custom activities.

LiMessageListFragment

Creates a list of articles for the selected board, including floated articles. If no board is in context, the creates a list of recent articles at the Community node level.

Layout files: li_fragment_articles.xml (for the rows in the list): li_fragment_support_home_item_list.xml (for the overall component)

LiCreateMessageFragment

Creates the form for posting a message, including a photo upload button and board chooser.

Layout file: li_fragment_ask_question.xml

LiBaseFragment

The abstract base fragment class for our UI elements.

LiBrowseFragment

Pulls the community structure and builds a navigation component to browse community categories and boards down to the message level. The fragment respects settings in Community Admin for categories and boards set to be hidden from lists and menus.

Layout files: li_browse_row_view.xml (for the rows in the browse list); li_fragment_support_home_item_list.xml (for the overall component)

LiConversationFragment

Pulls the selected conversation data (the thread topic and replies). Creates reply, kudo, and accept-as-solution functionality.

Layout file: li_fragment_messages.xml

LiOnArticleRowClickListener

Listens for taps on rows in screens that show messages lists. It brings up the message view. This fragment is not used standalone. The fragment is used by other fragments (LiUserActivityFragment, LiSearchFragment, LiMessageListFragment).

LiUserActivityFragment

Pulls the list messages posted by the current user, as well as the user's subscriptions. Builds a message list for display and creates the mechanism to tap to display the message view. Creates a button to create a new post.

Layout files: li_fragment_articles.xml (for the rows in the list); li_fragment_support_home_item_list.xml (for the overall component)

LiSearchFragment

Creates the keyword search input for searching the community and displays the search results. Creates the mechanism to open a search result item in the message view.

Layout files: li_fragment_articles.xml (for the rows in the list); li_fragment_support_home_item_list.xml (for the overall component)