pro.zackpollard.telegrambot.api.internal.chat

Class GroupChatImpl

java.lang.Object

pro.zackpollard.telegrambot.api.internal.chat.GroupChatImpl

All Implemented Interfaces:

Chat, GroupChat

public class GroupChatImpl
extends Object
implements GroupChat

Author:

Zack Pollard

Method Summary

Modifier and Type	Method and Description
static GroupChat	createGroupChat(int chatID, TelegramBot telegramBot)
static GroupChat	createGroupChat(org.json.JSONObject jsonObject, TelegramBot telegramBot)
TelegramBot	getBotInstance() Gets the TelegramBot instance associated with this Chat object
String	getId() Gets the ID of this Chat
String	getName() Gets the name of the group chat.
boolean	isAllMembersAreAdministrators() Used to get whether all of the members in the chat are administrators
boolean	kickChatMember(int userId) This method will kick the User with the specified User ID from the chat if they are currently in it
Message	sendMessage(SendableMessage message) Send any type of SendableMessage to this Chat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface pro.zackpollard.telegrambot.api.chat.GroupChat

getType

Methods inherited from interface pro.zackpollard.telegrambot.api.chat.Chat

getChatAdministrators, getChatMember, getChatMember, getChatMembersCount, leaveChat, sendMessage

Method Detail

createGroupChat

public static GroupChat createGroupChat(org.json.JSONObject jsonObject,
                                        TelegramBot telegramBot)

createGroupChat

public static GroupChat createGroupChat(int chatID,
                                        TelegramBot telegramBot)

getName

public String getName()

Gets the name of the group chat.

Specified by:

getName in interface Chat

Returns:

The group chat name, currently can be null due to chat creation by ID with no way of getting the group chats name from telegram servers.

getBotInstance

public TelegramBot getBotInstance()

Description copied from interface: Chat

Gets the TelegramBot instance associated with this Chat object

Specified by:

getBotInstance in interface Chat

Returns:

The TelegramBot instance associated with this Chat object

getId

public String getId()

Description copied from interface: Chat

Gets the ID of this Chat

Specified by:

getId in interface Chat

Returns:

The ID of this Chat

sendMessage

public Message sendMessage(SendableMessage message)

Description copied from interface: Chat

Send any type of SendableMessage to this Chat

Specified by:

sendMessage in interface Chat

Parameters:

message - The SendableMessage you want to send to the Chat

Returns:

The Message object associated with the sent message, or null if sending failed

isAllMembersAreAdministrators

public boolean isAllMembersAreAdministrators()

Description copied from interface: GroupChat

Used to get whether all of the members in the chat are administrators

Specified by:

isAllMembersAreAdministrators in interface GroupChat

Returns:

True if all members are administrators, otherwise False

kickChatMember

public boolean kickChatMember(int userId)

Description copied from interface: GroupChat

This method will kick the User with the specified User ID from the chat if they are currently in it

Specified by:

kickChatMember in interface GroupChat

Parameters:

userId - The User ID of the User you want to kick from the chat

Returns:

True if the user was kicked, otherwise False