A simple to use library to create nandbox Bots in Java
Just import the library to your project with one of the following options:
- Using Maven Central Repository:
<dependency>
<groupId>com.nandbox.bots.api</groupId>
<artifactId>bots-api</artifactId>
<version>1.0</version>
</dependency>After you download the library, you can easily build your bot by following the below steps:
1.Setup your configuration file once you get your bot configuration data from nandbox app , copy it to a proprieties file and name it config.properties then add it to the home directory of your project.
If you don't know how to get bot configuration data and token from nandbox
- Open your bot in nandbox app then open top right menu and click to
Get token.This process explained in this video.
You will get data like this:
token:90091783784280234234WBBPmJAnSD5ILIkc6N6QjY3ZzeY
url:wss://<SERVER>:<PORT>/nandbox/api/
download:https://<SERVER>:<PORT>/nandbox/download/
upload:https://<SERVER>:<PORT>/nandbox/upload/
save your token you will use it later and add other data to config.properties in the following format :
URI=wss://<SERVER>:<PORT>/nandbox/api/
DownloadServer=https://<SERVER>:<PORT>/nandbox/download/
UploadServer=https://<SERVER>:<PORT>/nandbox/upload/
2.Create your main class : After you created your Main class and added your main function please do the following :
1- Get instance from NandboxClient.
2- Call connect function and pass the following parameters to it :
a) token that you get in the prevouse step as String .
b) New Nandbox.Callback anonyomus instance and create a local Nandbox.Api variable and set it to null.
c) Implement the Nandbox.Callback() onConnect function and set Nandbox.Api local varable created in step (b) to onConnect function input parameter api . d) You can implment other nesseeary functions.
You can simply copy the below code snippet and replace token with your bot token and implment the nesessery functions .
public class MyFirstBot {
public static void main(String[] args) throws Exception {
NandboxClient client = NandboxClient.get();
client.connect(TOKEN, new Nandbox.Callback() {
Nandbox.Api api = null;
@Override
public void onConnect(Api api) {
// it will go here if the bot connected to server successfuly
System.out.println("Authenticated");
this.api = api;
}
@Override
public void onReceive(IncomingMessage incomingMsg) {
// it will go here if the bot received any message
}
// implement other nandbox.Callback() as per your bot need .
});
}
}client.connect(token, new Nandbox.Callback() : this method to connect to server please add your bot token instead of token
3.Creating Simple Echo Bot : below is a sample code that creating a simple echo bot that echos everything sent to it.
public class EchoTextMessage {
public static final String TOKEN = "<PUT your token here >";
public static void main(String[] args) throws Exception {
NandboxClient client = NandboxClient.get();
client.connect(TOKEN, new Nandbox.Callback() {
Nandbox.Api api = null;
@Override
public void onConnect(Api api) {
System.out.println("Authenticated");
this.api = api;
}
@Override
public void onReceive(IncomingMessage incomingMsg) {
if (incomingMsg.isTextMsg()) {
String chatId = incomingMsg.getChat().getId(); // get your chat Id
String text = incomingMsg.getText(); // get your text message
api.sendText(chatId, text); // Sending message back as an Echo
}
}
@Override
public void onReceive(JSONObject obj) {
}
@Override
public void onClose() {
}
@Override
public void onError() {
}
@Override
public void onChatMenuCallBack(ChatMenuCallback chatMenuCallback) {
}
@Override
public void onMessagAckCallback(MessageAck msgAck) {
}
@Override
public void onUserJoinedBot(User user) {
}
@Override
public void onChatMember(ChatMember chatMember) {
}
@Override
public void onChatAdministrators(ChatAdministrators chatAdministrators) {
}
@Override
public void userStartedBot(User user) {
}
@Override
public void onMyProfile(User user) {
}
@Override
public void onUserDetails(User user) {
}
@Override
public void userStoppedBot(User user) {
}
@Override
public void userLeftBot(User user) {
}
@Override
public void onInlineMessageCallback(InlineMessageCallback inlineMsgCallback) {
}
@Override
public void permanentUrl(PermanentUrl permenantUrl) {
}
@Override
public void onChatDetails(Chat chat) {
}
@Override
public void onInlineSearh(InlineSearch inlineSearch) {
}
});
}
}--
MIT License
Copyright (c) 2022 nandbox
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.