pro.zackpollard.telegrambot.api.internal.chat

Class SuperGroupChatImpl

java.lang.Object

pro.zackpollard.telegrambot.api.internal.chat.SuperGroupChatImpl

All Implemented Interfaces:

Chat, GroupChat, SuperGroupChat

public class SuperGroupChatImpl
extends Object
implements SuperGroupChat

Author:

Zack Pollard

Method Summary

Modifier and Type	Method and Description
static SuperGroupChat	createSuperGroupChat(org.json.JSONObject jsonObject, TelegramBot telegramBot)
static SuperGroupChat	createSuperGroupChat(long chatID, 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.
String	getUsername() Gets the Username of the SuperGroup that this SuperGroupChat object refers to
boolean	isAllMembersAreAdministrators() Used to get whether all of the members in the chat are administrators
boolean	kickChatMember(int userId) This method will kick and ban 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
boolean	unbanChatMember(int userId) This method will unban a user that was previously banned from the 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.SuperGroupChat

getType

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

getChatAdministrators, getChatMember, getChatMember, getChatMembersCount, leaveChat, sendMessage

Method Detail

createSuperGroupChat

public static SuperGroupChat createSuperGroupChat(org.json.JSONObject jsonObject,
                                                  TelegramBot telegramBot)

createSuperGroupChat

public static SuperGroupChat createSuperGroupChat(long 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

getUsername

public String getUsername()

Description copied from interface: SuperGroupChat

Gets the Username of the SuperGroup that this SuperGroupChat object refers to

Specified by:

getUsername in interface SuperGroupChat

Returns:

The Username of this SuperGroup

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: SuperGroupChat

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

Specified by:

kickChatMember in interface GroupChat

Specified by:

kickChatMember in interface SuperGroupChat

Parameters:

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

Returns:

True if the user was kicked, otherwise False

unbanChatMember

public boolean unbanChatMember(int userId)

Description copied from interface: SuperGroupChat

This method will unban a user that was previously banned from the chat

Specified by:

unbanChatMember in interface SuperGroupChat

Parameters:

userId - The ID of the User you want to unban

Returns:

True if the user was unbanned, otherwise False