LiClientManager (li-android-sdk-core 1.2.5 API)

java.lang.Object
- lithium.community.android.sdk.manager.LiClientManager

```
public class LiClientManager
extends java.lang.Object
```
This class acts as a manager to hold and refresh the user's authentication state. It includes all of the API providers to interact with the community.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LiClientManager.Client` Enum of all clients.
`static class`	`LiClientManager.CollectionsType` Enum of all collection types.

Constructor Summary

Constructors
Constructor and Description

LiClientManager()

Constructors
Constructor and Description
`LiClientManager()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static LiClient`	`getAcceptSolutionClient(LiClientRequestParams liClientRequestParams)` Marks a message as an accepted solution.
`static LiClient`	`getBeaconClient(LiClientRequestParams liClientRequestParams)` This is a beacon client which is used to send information to the community backend for analytics aka LSI
`static LiClient`	`getBoardsByDepthClient(LiClientRequestParams liClientRequestParams)` Fetches boards at a specific depth in the Community Structure hierarchy.
`static LiClient`	`getCategoryBoardsClient(LiClientRequestParams liClientRequestParams)` Fetches a list of boards for a given category, along with board and category details.
`static LiClient`	`getCategoryClient(LiClientRequestParams liClientRequestParams)` Fetches category details available to the user in context.
`static LiClient`	`getCreateMessageClient(LiClientRequestParams liClientRequestParams)` Posts a new message to the community.
`static LiClient`	`getCreateReplyClient(LiClientRequestParams liClientRequestParams)` Creates a reply or comment.
`static LiClient`	`getCreateUserClient(LiClientRequestParams liClientRequestParams)` Creates new user account.
`static LiClient`	`getDeviceIdFetchClient(LiClientRequestParams liClientRequestParams)` Fetches the ID corresponding to device ID from the community.
`static LiClient`	`getDeviceIdUpdateClient(LiClientRequestParams liClientRequestParams)` Updates the device ID in community with the given device ID.
`static LiClient`	`getFloatedMessagesClient(LiClientRequestParams liClientRequestParams)` Fetches details of all floated (or "pinned") of the specified board for the user in context.
`static LiClient`	`getGenericLiqlGetClient(LiClientRequestParams liClientRequestParams)` This is generic Get client.
`static LiClient`	`getGenericNoLiqlGetClient(LiClientRequestParams liClientRequestParams)` This is generic Get client.
`static LiClient`	`getGenericPostClient(LiClientRequestParams liClientRequestParams)` This is generic Post client.
`static LiClient`	`getGenericPutClient(LiClientRequestParams liClientRequestParams)` This is generic PUT client.
`static LiClient`	`getGenericQueryDeleteClient(LiClientRequestParams liClientRequestParams)` This is a generic DELETE client.
`static LiClient`	`getGenericQueryParamsGetClient(LiClientRequestParams liClientRequestParams)` Creates custom WHERE clause, ORDER BY, and/or LIMIT parameters to a LIQL queries used by a Lithium API provider.
`static LiClient`	`getKudoClient(LiClientRequestParams liClientRequestParams)` Kudos the specified message for the user in context.
`static LiClient`	`getMarkMessagePostClient(LiClientRequestParams liClientRequestParams)` Mark a single message as read or unread Create parameters with `LiClientRequestParams.LiMarkMessageParams`.
`static LiClient`	`getMarkMessagesPostClient(LiClientRequestParams liClientRequestParams)` Marks a set of messages (not necessarily in the same thread) as read or unread.
`static LiClient`	`getMarkTopicPostClient(LiClientRequestParams liClientRequestParams)` Marks a topic message and all its replies as read or unread.
`static LiClient`	`getMessageClient(LiClientRequestParams liClientRequestParams)` Fetches details of the specified message.
`static LiClient`	`getMessageDeleteClient(LiClientRequestParams liClientRequestParams)` Deletes the specified message.
`static LiClient`	`getMessagesByBoardIdClient(LiClientRequestParams liClientRequestParams)` Fetches all articles on the specified board, authored by the user in context.
`static LiClient`	`getMessagesByIdsClient(LiClientRequestParams liClientRequestParams)` Fetches details for the specified set of messages.
`static LiClient`	`getMessagesClient(LiClientRequestParams liClientRequestParams)` Fetches a list of all the articles for the user in context ordered by post time or kudos count.
`static LiClient`	`getRepliesClient(LiClientRequestParams liClientRequestParams)` Fetches details of child messages of the specified message.
`static LiClient`	`getReportAbuseClient(LiClientRequestParams liClientRequestParams)` Creates an abuse report for the specified message.
`static LiRestv2Client`	`getRestClient()`
`static LiClient`	`getSdkSettingsClient(LiClientRequestParams liClientRequestParams)` Fetches all the SDK settings from the Community app.
`static LiClient`	`getSearchClient(LiClientRequestParams liClientRequestParams)` Performs a keyword search in the community.
`static LiClient`	`getSubscriptionDeleteClient(LiClientRequestParams liClientRequestParams)` Deletes a subscription.
`static LiClient`	`getSubscriptionPostClient(LiClientRequestParams liClientRequestParams)` Creates a subscription to the specified target (a board or message).
`static LiClient`	`getUnKudoClient(LiClientRequestParams liClientRequestParams)` Unkudos the specified message for the user in context.
`static LiClient`	`getUpdateMessageClient(LiClientRequestParams liClientRequestParams)` Updates an existing message by ID.
`static LiClient`	`getUpdateUserClient(LiClientRequestParams liClientRequestParams)` Updates an existing user.
`static LiClient`	`getUploadImageClient(LiClientRequestParams liClientRequestParams)` Uploads an image to the community on behalf of the user in context.
`static LiClient`	`getUserDetailsClient(LiClientRequestParams liClientRequestParams)` Fetches all details about the specified user.
`static LiClient`	`getUserMessagesClient(LiClientRequestParams liClientRequestParams)` Fetches messages posted by a specified author up to a specified depth in the Community Structure hierarchy.
`static LiClient`	`getUserSubscriptionsClient(LiClientRequestParams liClientRequestParams)` Fetches a list of all Community subscriptions for the user in context.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LiClientManager
```
public LiClientManager()
```
- Method Detail
  - getRestClient
```
public static LiRestv2Client getRestClient()
                                    throws LiRestResponseException
```
    Throws:
    
    LiRestResponseException
  - getMessagesClient
```
public static LiClient getMessagesClient(LiClientRequestParams liClientRequestParams)
                                  throws LiRestResponseException
```
    Fetches a list of all the articles for the user in context ordered by post time or kudos count. Create parameters with .
    
    Parameters:
    
    liClientRequestParams - the Android context (required)
    
    Returns:
    
    LiMessage LiMessage
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getMessagesByBoardIdClient
```
public static LiClient getMessagesByBoardIdClient(LiClientRequestParams liClientRequestParams)
                                           throws LiRestResponseException
```
    Fetches all articles on the specified board, authored by the user in context. Create parameters with .
    
    Parameters:
    
    liClientRequestParams - the Android context (required)
    
    liClientRequestParams - the ID of the board from which to fetch the messages (required)
    
    Returns:
    
    LiMessage LiMessage
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getSdkSettingsClient
```
public static LiClient getSdkSettingsClient(LiClientRequestParams liClientRequestParams)
                                     throws LiRestResponseException
```
    Fetches all the SDK settings from the Community app. Create parameters with .
    
    Parameters:
    
    liClientRequestParams - the Android context (required)
    
    liClientRequestParams - the client ID (required)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getUserSubscriptionsClient
```
public static LiClient getUserSubscriptionsClient(LiClientRequestParams liClientRequestParams)
                                           throws LiRestResponseException
```
    Fetches a list of all Community subscriptions for the user in context. Create parameters with .
    
    Parameters:
    
    liClientRequestParams - the Android context (required)
    
    Returns:
    
    LiSubscription LiSubscriptions
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getCategoryBoardsClient
```
public static LiClient getCategoryBoardsClient(LiClientRequestParams liClientRequestParams)
                                        throws LiRestResponseException
```
    Fetches a list of boards for a given category, along with board and category details. Create parameters with LiClientRequestParams.LiCategoryBoardsClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiCategoryBoardsClientRequestParams the Android context (required)
    
    liClientRequestParams - the category ID (required)
    
    Returns:
    
    LiBrowse LiBrowse
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getBoardsByDepthClient
```
public static LiClient getBoardsByDepthClient(LiClientRequestParams liClientRequestParams)
                                       throws LiRestResponseException
```
    Fetches boards at a specific depth in the Community Structure hierarchy. 0 is the highest level in the structure. Create parameters with LiClientRequestParams.LiBoardsByDepthClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiBoardsByDepthClientRequestParams the Android context (required)
    
    liClientRequestParams - the depth of boards to include in the query (required)
    
    Returns:
    
    LiBrowse LiBrowse
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getRepliesClient
```
public static LiClient getRepliesClient(LiClientRequestParams liClientRequestParams)
                                 throws LiRestResponseException
```
    Fetches details of child messages of the specified message. Child messages include replies comments, as well as nested replies or comments. Create parameters with LiClientRequestParams.LiRepliesClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiRepliesClientRequestParams the Android context (required)
    
    liClientRequestParams - the ID of the parent message (required)
    
    Returns:
    
    LiMessage LiMessage
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getSearchClient
```
public static LiClient getSearchClient(LiClientRequestParams liClientRequestParams)
                                throws LiRestResponseException
```
    Performs a keyword search in the community. Create parameters with LiClientRequestParams.LiSearchClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiSearchClientRequestParams the Android context (required)
    
    liClientRequestParams - the text string to search, passed as 'query'. The 'query' parameter is compared with the body and subject of the message. (required)
    
    Returns:
    
    LiMessage LiMessage
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getUserMessagesClient
```
public static LiClient getUserMessagesClient(LiClientRequestParams liClientRequestParams)
                                      throws LiRestResponseException
```
    Fetches messages posted by a specified author up to a specified depth in the Community Structure hierarchy. Crate parameters with LiClientRequestParams.LiUserMessagesClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiUserMessagesClientRequestParams the Android context (required)
    
    liClientRequestParams - the ID of the author (required)
    
    liClientRequestParams - the depth of the message, where the a topic message = 0, the first reply = 1, and so on (required)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getCategoryClient
```
public static LiClient getCategoryClient(LiClientRequestParams liClientRequestParams)
                                  throws LiRestResponseException
```
    Fetches category details available to the user in context. This method respects the Hide from Lists and Menus setting in Community Admin. Create parameters with LiClientRequestParams.LiCategoryClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiCategoryClientRequestParams the Android context (required)
    
    Returns:
    
    LiBrowse LiBrowse
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getUserDetailsClient
```
public static LiClient getUserDetailsClient(LiClientRequestParams liClientRequestParams)
                                     throws LiRestResponseException
```
    Fetches all details about the specified user. Create parameters with LiClientRequestParams.LiUserDetailsClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiUserDetailsClientRequestParams the Android context (required)
    
    liClientRequestParams - the ID of the user (required)
    
    Returns:
    
    LUser LiUser
    
    Throws:
    
    LiRestResponseException - LiClient LiRestResponseException
  - getMessageClient
```
public static LiClient getMessageClient(LiClientRequestParams liClientRequestParams)
                                 throws LiRestResponseException
```
    Fetches details of the specified message. Create parameters with LiClientRequestParams.LiMessageClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiMessageClientRequestParams the Android context (required)
    
    liClientRequestParams - the ID of the message (required)
    
    Returns:
    
    LiMessage LiMessage
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getFloatedMessagesClient
```
public static LiClient getFloatedMessagesClient(LiClientRequestParams liClientRequestParams)
                                         throws LiRestResponseException
```
    Fetches details of all floated (or "pinned") of the specified board for the user in context. Create parameters with .
    
    Parameters:
    
    liClientRequestParams - the Android context (required)
    
    liClientRequestParams - the ID of the board (required)
    
    liClientRequestParams - the scope for searching the floated messages. Supported scopes: "global", "local" (required)
    
    Returns:
    
    LiFloatedMessageModel LiFloatedMessageModel
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getMessagesByIdsClient
```
public static LiClient getMessagesByIdsClient(LiClientRequestParams liClientRequestParams)
                                       throws LiRestResponseException
```
    Fetches details for the specified set of messages. Create parameters with .
    
    Parameters:
    
    liClientRequestParams - the Android context (required)
    
    liClientRequestParams - the IDs of the messages, passed as a set (required)
    
    Returns:
    
    LiMessages LiMessage
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getKudoClient
```
public static LiClient getKudoClient(LiClientRequestParams liClientRequestParams)
                              throws LiRestResponseException
```
    Kudos the specified message for the user in context. Create parameters with LiClientRequestParams.LiKudoClientRequestParams. Uses LiPostKudoModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiKudoClientRequestParams the Android context (required)
    
    liClientRequestParams - the ID of the message to kudo (required)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getUnKudoClient
```
public static LiClient getUnKudoClient(LiClientRequestParams liClientRequestParams)
                                throws LiRestResponseException
```
    Unkudos the specified message for the user in context. Create parameters with LiClientRequestParams.LiUnKudoClientRequestParams. Uses LiPostKudoModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiUnKudoClientRequestParams the Android context (required)
    
    liClientRequestParams - the ID of the message to unkudoed (required)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getAcceptSolutionClient
```
public static LiClient getAcceptSolutionClient(LiClientRequestParams liClientRequestParams)
                                        throws LiRestResponseException
```
    Marks a message as an accepted solution. Create parameters with LiClientRequestParams.LiAcceptSolutionClientRequestParams. Uses LiAcceptSolutionModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiAcceptSolutionClientRequestParams the Android context (required)
    
    liClientRequestParams - the ID of the message to mark as a solution (required)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getCreateMessageClient
```
public static LiClient getCreateMessageClient(LiClientRequestParams liClientRequestParams)
                                       throws LiRestResponseException
```
    Posts a new message to the community. Create parameters with LiClientRequestParams.LiCreateMessageClientRequestParams. Uses LiPostMessageModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiCreateMessageClientRequestParams the Android context (required)
    
    liClientRequestParams - the subject of the message (required)
    
    liClientRequestParams - the body of the message (required)
    
    liClientRequestParams - the image filename (if an image is included in the message)
    
    liClientRequestParams - the image ID (if an image is included in the message)
    
    liClientRequestParams - the ID of the board where the message will be posted (required)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getUpdateMessageClient
```
public static LiClient getUpdateMessageClient(LiClientRequestParams liClientRequestParams)
                                       throws LiRestResponseException
```
    Updates an existing message by ID. Crate parameters with LiClientRequestParams.LiUpdateMessageClientRequestParams. Uses LiPostMessageModel to build the request body. The model is converted to a JsonObject, which is then used in the PUT call.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiUpdateMessageClientRequestParams the Android context (required)
    
    liClientRequestParams - the message subject
    
    liClientRequestParams - the message body
    
    liClientRequestParams - the message ID (required)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getCreateReplyClient
```
public static LiClient getCreateReplyClient(LiClientRequestParams liClientRequestParams)
                                     throws LiRestResponseException
```
    Creates a reply or comment. Create parameters with LiClientRequestParams.LiCreateReplyClientRequestParams. Uses LiReplyMessageModel to build request body. The model is converted to a JsonObject, which is then used in the POST call.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiCreateReplyClientRequestParams the Android context (required)
    
    liClientRequestParams - the message ID (required)
    
    liClientRequestParams - the message body (required)
    
    liClientRequestParams - the image filename (if the message includes an image)
    
    liClientRequestParams - the image ID (if the message includes an image)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiClient LiRestResponseException
  - getUploadImageClient
```
public static LiClient getUploadImageClient(LiClientRequestParams liClientRequestParams)
                                     throws LiRestResponseException
```
    Uploads an image to the community on behalf of the user in context. The image is placed into the user's public album. Create parameters with LiClientRequestParams.LiUploadImageClientRequestParams. Uses LiUploadImageModel to build request body. The model is converted to a JsonObject, which is then used in the POST call.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiUploadImageClientRequestParams the Android context (required)
    
    liClientRequestParams - the image title (required)
    
    liClientRequestParams - the image filename (required)
    
    liClientRequestParams - the absolute path to the image (required) Note: the image filename and the filename in the absolute path param above must be equal.
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getReportAbuseClient
```
public static LiClient getReportAbuseClient(LiClientRequestParams liClientRequestParams)
                                     throws LiRestResponseException
```
    Creates an abuse report for the specified message. Create parameters with LiClientRequestParams.LiReportAbuseClientRequestParams. Uses the LiMarkAbuseModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    Added 1.0.2
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiReportAbuseClientRequestParams the Android context (required)
    
    liClientRequestParams - the ID of message to report (required)
    
    liClientRequestParams - the message body of the message being reported (required)
    
    liClientRequestParams - the ID of the user making the abuse report (required)
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getDeviceIdFetchClient
```
public static LiClient getDeviceIdFetchClient(LiClientRequestParams liClientRequestParams)
                                       throws LiRestResponseException
```
    Fetches the ID corresponding to device ID from the community. Create parameters with LiClientRequestParams.LiDeviceIdFetchClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiDeviceIdFetchClientRequestParams the ID registered with notification provider
    
    liClientRequestParams - the Global provider for Push notification. Currently "GCM" and "FIREBASE".
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getDeviceIdUpdateClient
```
public static LiClient getDeviceIdUpdateClient(LiClientRequestParams liClientRequestParams)
                                        throws LiRestResponseException
```
    Updates the device ID in community with the given device ID. Create parameters with LiClientRequestParams.LiDeviceIdUpdateClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiDeviceIdUpdateClientRequestParams the Android context (required)
    
    liClientRequestParams - the device ID registered with the push notification provider (required)
    
    liClientRequestParams - the ID corresponding to device ID in the community (required)
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getCreateUserClient
```
public static LiClient getCreateUserClient(LiClientRequestParams liClientRequestParams)
                                    throws LiRestResponseException
```
    Creates new user account. Create parameters with LiClientRequestParams.LiCreateUserParams. Uses LiCreateUpdateUserModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    Added 1.1.0
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiCreateUserParams the Android context (required)
    
    liClientRequestParams - the user's login (required)
    
    liClientRequestParams - the user's password (required)
    
    liClientRequestParams - the user's email (required)
    
    liClientRequestParams - the user's avatar
    
    liClientRequestParams - the user's biography
    
    liClientRequestParams - the user's first name
    
    liClientRequestParams - the user's last name
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException
  - getMarkMessagePostClient
```
public static LiClient getMarkMessagePostClient(LiClientRequestParams liClientRequestParams)
                                         throws LiRestResponseException
```
    Mark a single message as read or unread Create parameters with LiClientRequestParams.LiMarkMessageParams. Uses the LiMarkMessageModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    Added 1.1.0
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiMarkMessageParams the Android context (required)
    
    liClientRequestParams - the ID of the user marking the message (required)
    
    liClientRequestParams - the ID of the message (required)
    
    liClientRequestParams - whether to mark the message read or unread. Pass 'markUnread' as 'true' to mark the message as read. (required)
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException
  - getMarkMessagesPostClient
```
public static LiClient getMarkMessagesPostClient(LiClientRequestParams liClientRequestParams)
                                          throws LiRestResponseException
```
    Marks a set of messages (not necessarily in the same thread) as read or unread. Compare this to getMarkTopicPostClient. Create parameters with LiClientRequestParams.LiMarkMessagesParams. Uses the LiMarkMessagesModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    Added 1.1.0
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiMarkMessagesParams the Android context
    
    liClientRequestParams - the user marking the messages (required)
    
    liClientRequestParams - the IDs of the messages to mark in a comma-separated list (required)
    
    liClientRequestParams - whether to mark the messages read or unread. Pass 'markUnread' as 'true' to mark the messages as read. (required)
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException
  - getMarkTopicPostClient
```
public static LiClient getMarkTopicPostClient(LiClientRequestParams liClientRequestParams)
                                       throws LiRestResponseException
```
    Marks a topic message and all its replies as read or unread. Compare this to getMarkMessagesPostClient. Create parameters with LiClientRequestParams.LiMarkTopicParams. Uses the LiMarkTopicModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    Added 1.1.0
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiMarkTopicParams the Android context (required)
    
    liClientRequestParams - the ID of the topic message to mark (required)
    
    liClientRequestParams - whether to mark the messages read or unread. Pass 'markUnread' as 'true' to mark the messages as read. (required)
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException
  - getSubscriptionPostClient
```
public static LiClient getSubscriptionPostClient(LiClientRequestParams liClientRequestParams)
                                          throws LiRestResponseException
```
    Creates a subscription to the specified target (a board or message). Create parameters with LiClientRequestParams.LiPostSubscriptionParams.
    The parameters can either be a target which is a LiBaseModel in the form of LiMessage or LiBrowse which was selected to be subscribed to and needs to be passed in the constructor
    Alternatively in the parameters "message/boardId" and "type" need to be passed in the constructor. "type" is either "message" or "board" depending upon what was selected.
    If both are set then the target takes precedence and string parameters are ignored.
    Uses the LiSubscriptionPostModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    Added 1.0.1
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiPostSubscriptionParams the Android context (required)
    
    liClientRequestParams - the target of the subscription -- a board or message (required)
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException
  - getSubscriptionDeleteClient
```
public static LiClient getSubscriptionDeleteClient(LiClientRequestParams liClientRequestParams)
                                            throws LiRestResponseException
```
    Deletes a subscription.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiDeleteSubscriptionParams the Android context
    
    liClientRequestParams - the subscription ID
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException
  - getUpdateUserClient
```
public static LiClient getUpdateUserClient(LiClientRequestParams liClientRequestParams)
                                    throws LiRestResponseException
```
    Updates an existing user. Create parameters with LiClientRequestParams.LiUpdateUserParams. Uses LiCreateUpdateUserModel to build the request body. The model is converted to a JsonObject, which is then used in the POST call.
    Added 1.1.0
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiUpdateUserParams the Android context (required)
    
    liClientRequestParams - the user's avatar image url
    
    liClientRequestParams - the user's avatar image external url
    
    liClientRequestParams - the user's avatar image internal url
    
    liClientRequestParams - the user's avatar image id
    
    liClientRequestParams - the user's biography
    
    liClientRequestParams - the user's cover image
    
    liClientRequestParams - the user's email
    
    liClientRequestParams - the user's first name
    
    liClientRequestParams - the user's last name
    
    liClientRequestParams - the user's login
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException
  - getGenericPostClient
```
public static LiClient getGenericPostClient(LiClientRequestParams liClientRequestParams)
                                     throws LiRestResponseException
```
    This is generic Post client. Provide a path to a Community API v1 or v2 endpoint and a request body. Create parameters with LiClientRequestParams.LiGenericPostClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiGenericPostClientRequestParams the Android context
    
    liClientRequestParams - the path to a Community v1 or v2 endpoint
    
    liClientRequestParams - the request body as a JsonObject
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getBeaconClient
```
public static LiClient getBeaconClient(LiClientRequestParams liClientRequestParams)
                                throws LiRestResponseException
```
    This is a beacon client which is used to send information to the community backend for analytics aka LSI
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiBeaconPostClientRequestParams
    
    Throws:
    
    LiRestResponseException
  - getGenericPutClient
```
public static LiClient getGenericPutClient(LiClientRequestParams liClientRequestParams)
                                    throws LiRestResponseException
```
    This is generic PUT client. Provide the path to a Community API v1 or v2 endpoint and a request body. Create parameters with LiClientRequestParams.LiGenericPutClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiGenericPutClientRequestParams the Android context (required)
    
    liClientRequestParams - the path to a Community v1 or v2 endpoint (required)
    
    liClientRequestParams - the request body as a JsonObject (required)
    
    Returns:
    
    LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getGenericLiqlGetClient
```
public static LiClient getGenericLiqlGetClient(LiClientRequestParams liClientRequestParams)
                                        throws LiRestResponseException
```
    This is generic Get client. Provide a LiQL query. Create parameters with LiClientRequestParams.LiGenericLiqlClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiGenericLiqlClientRequestParams the Android context (required)
    
    liClientRequestParams - a custom LiQL query (required)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getGenericNoLiqlGetClient
```
public static LiClient getGenericNoLiqlGetClient(LiClientRequestParams liClientRequestParams)
                                          throws LiRestResponseException
```
    This is generic Get client. Provide a LiQL query. Create parameters with LiClientRequestParams.LiGenericLiqlClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiGenericLiqlClientRequestParams the Android context (required)
    
    liClientRequestParams - a custom LiQL query (required)
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException
  - getGenericQueryParamsGetClient
```
public static LiClient getGenericQueryParamsGetClient(LiClientRequestParams liClientRequestParams)
```
    Creates custom WHERE clause, ORDER BY, and/or LIMIT parameters to a LIQL queries used by a Lithium API provider. Create parameters with LiClientRequestParams.LiGenericQueryParamsClientRequestParams.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiGenericQueryParamsClientRequestParams the Android context
    
    Returns:
    
    LiClient LiClient
  - getGenericQueryDeleteClient
```
public static LiClient getGenericQueryDeleteClient(LiClientRequestParams liClientRequestParams)
                                            throws LiRestResponseException
```
    This is a generic DELETE client.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiGenericDeleteClientRequestParams
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException
  - getMessageDeleteClient
```
public static LiClient getMessageDeleteClient(LiClientRequestParams liClientRequestParams)
                                       throws LiRestResponseException
```
    Deletes the specified message. Create parameters with LiClientRequestParams.LiMessageDeleteClientRequestParams. Optionally pass the 'includeReplies' parameters as 'true' to delete replies or comments associated with the message.
    
    Parameters:
    
    liClientRequestParams - LiClientRequestParams.LiMessageDeleteClientRequestParams the Android context
    
    liClientRequestParams - the ID of the message to delete
    
    liClientRequestParams - whether or not to delete replies/comments to the message
    
    Returns:
    
    LiClient LiClient
    
    Throws:
    
    LiRestResponseException - LiRestResponseException

Class LiClientManager

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LiClientManager

Method Detail

getRestClient

getMessagesClient

getMessagesByBoardIdClient

getSdkSettingsClient

getUserSubscriptionsClient

getCategoryBoardsClient

getBoardsByDepthClient

getRepliesClient

getSearchClient

getUserMessagesClient

getCategoryClient

getUserDetailsClient

getMessageClient

getFloatedMessagesClient

getMessagesByIdsClient

getKudoClient

getUnKudoClient

getAcceptSolutionClient

getCreateMessageClient

getUpdateMessageClient

getCreateReplyClient

getUploadImageClient

getReportAbuseClient

getDeviceIdFetchClient

getDeviceIdUpdateClient

getCreateUserClient

getMarkMessagePostClient

getMarkMessagesPostClient

getMarkTopicPostClient

getSubscriptionPostClient

getSubscriptionDeleteClient

getUpdateUserClient

getGenericPostClient

getBeaconClient

getGenericPutClient

getGenericLiqlGetClient

getGenericNoLiqlGetClient

getGenericQueryParamsGetClient

getGenericQueryDeleteClient

getMessageDeleteClient