pro.zackpollard.telegrambot.api.chat

Interface Chat

All Known Subinterfaces:

ChannelChat, GroupChat, IndividualChat, SuperGroupChat

All Known Implementing Classes:

ChannelChatImpl, GroupChatImpl, IndividualChatImpl, SuperGroupChatImpl

public interface Chat

Author:

Zack Pollard

Method Summary

Modifier and Type	Method and Description
TelegramBot	getBotInstance() Gets the TelegramBot instance associated with this Chat object
default List<ChatMember>	getChatAdministrators() Gets a List of ChatMember objects for all the people who are admin in the chat
default ChatMember	getChatMember(long userID) Gets the ChatMember object for a specific user based on their ID in respect to this chat
default ChatMember	getChatMember(User user) Gets the ChatMember object for a specific User in respect to this chat
default Integer	getChatMembersCount() Gets the amount of people in the chat
String	getId() Gets the ID of this Chat
String	getName() Gets the name of the Chat
ChatType	getType() Gets the ChatType of this Chat
default boolean	leaveChat() If you call this method then the bot will leave this Chat if it is currently in it
Message	sendMessage(SendableMessage message) Send any type of SendableMessage to this Chat
default Message	sendMessage(String message) Send a String message to this Chat

Method Detail

getId

String getId()

Gets the ID of this Chat

Returns:

The ID of this Chat

getName

String getName()

Gets the name of the Chat

Returns:

The name of the Chat

getType

ChatType getType()

Gets the ChatType of this Chat

Returns:

The ChatType of this Chat

getBotInstance

TelegramBot getBotInstance()

Gets the TelegramBot instance associated with this Chat object

Returns:

The TelegramBot instance associated with this Chat object

sendMessage

Message sendMessage(SendableMessage message)

Send any type of SendableMessage to this 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

sendMessage

default Message sendMessage(String message)

Send a String message to this Chat

Parameters:

message - The String message you want to send to the chat

Returns:

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

getChatMembersCount

default Integer getChatMembersCount()

Gets the amount of people in the chat

Returns:

The amount of people in the chat

getChatAdministrators

default List<ChatMember> getChatAdministrators()

Gets a List of ChatMember objects for all the people who are admin in the chat

Returns:

A List of ChatMember objects for all the people who are admin in the chat

getChatMember

default ChatMember getChatMember(User user)

Gets the ChatMember object for a specific User in respect to this chat

Parameters:

user - The User that you want the ChatMember object for

Returns:

The ChatMember object for this user or Null if the request failed

getChatMember

default ChatMember getChatMember(long userID)

Gets the ChatMember object for a specific user based on their ID in respect to this chat

Parameters:

userID - The ID of the user that you want the ChatMember object for

Returns:

The ChatMember object for this user or Null if the request failed

leaveChat

default boolean leaveChat()

If you call this method then the bot will leave this Chat if it is currently in it

Returns:

True if leaving the chat succeeded, otherwise False