The SDK currently provides two components. The first is a Java Connection API that makes it easy to access LIVE CHAT libre from a Java environment such as Android, or a Java web server. The second component is a set of Android activities that you can add to your own Android app, or copy/customize in your own app.
The SDK is developed under Project Libre an open source project hosted on GitHub
Connection APIYou can create a connection to the LIVE CHAT libre server using the SDKConnection class. You need to pass your connection Credentials, which includes your application ID. You can obtain an application from the LIVE CHAT libre website, from your user details page.
SDKConnection connection = new SDKConnection(new LIVECHATlibreCredential("12345");
The SDK includes a set of data objects that represent the LIVE CHAT libre object model.
The data objects are in the com.paphus.sdk.config package, and include the following,
- UserConfig - Defines a user's credentials and info.
- BrowseConfig - Defines a search query criteria.
- ChannelConfig - Defines a live chat channel's details.
- InstanceConfig - Defines a bot's details.
- ForumConfig - Defines a forum's details.
- ForumPostConfig - Defines a forum post.
- DomainConfig - Defines a domain's details.
- ChatConfig - Input for chat bot messaging.
- VoiceConfig - Defines a chat bot's voice.
- ChatResponse - Response for chat bot messaging.
- ContentConfig - Defines a tag/category request.
UsersThe API allows you to connect a user, or create a new user.
Use the connect() API to connect a user, the user's details will be returned, or an error message if the connect fails. The returned user details will not include the password, but will include a token, that can be used in place of the password. After connecting a connection, all subsequent requests will use the user credentials, until you call disconnect().
UserConfig user = new UserConfig(); user.user = "test"; user.password = "password"; user = connection.connect(user);
Use the create() API to create a new user. A user id and password are required. You can also pass the user's name, email, bio, and other details. The user details are returned, with a token in place of the password.
UserConfig user = new UserConfig(); user.user = "test"; user.password = "password"; user.name = "Test Account"; user.email = "firstname.lastname@example.org"; user = connection.create(user);
Live ChatThe API allows you to browse channels, and get channel details.
The browse() API is used to browse or search the set of channels in the domain.
BrowseConfig browse = new BrowseConfig(); browse.type = "Channel"; browse.typeFilter= "Public"; browse.tag= "cool"; browse.sort = "name"; List channels = connection.browse(browse);
The fetch() API is used to get a channel's details.
ChannelConfig channel = new ChannelConfig(); channel.id = "12345"; channel = connection.fetch(channel);
The LiveChatConnection class is used to chat in a channel. It can be created using the openLiveChat() API on the SDKConnection class. You must pass the ChannelConfig with its id set, and an implementation of LiveChatListener that will receive the chat messages. Once you have a connection established, you can send and receive messages.
ChannelConfig channel = new ChannelConfig(); channel.id = "12345"; LiveChatConnection livechat = connection.openLiveChat(channel, myListener); livechat.sendMessage("Hello World");
Android ActivitiesThe SDK includes a set of Android activities you can reuse, or modify in your own app. The MainActivity contains the SDKConnection and some shared data, so you will need to include it even if not using the activity. The live chat activities include, ChooseChannelActivity, ChannelActivity, ChannelBrowseActivity, and LiveChatActivity.
Here is an example of launching a ChannelActivity.
MainActivity.current = new MainActivity(); ChannelConfig config = new ChannelConfig(); config.id = "12345"; HttpAction action = new HttpFetchAction(this, config); action.execute();
Note, because of the way Android does its packaging, you will need to search/replace the "com.paphus.sdk.activity.R" import with your own application's unique package. This will resolve the generated R class dependencies.
You can use the SDK to access any of LIVE CHAT libre's services, for personal, academic, or commercial applications. You cannot use them for spam, or to violate the LIVE CHAT libre terms of service. LIVE CHAT libre's services are also provided as a commercial service on Paphus Live Chat.