GroupMeBot Class

CkSoftware GroupMe SDK - Documentation

Management class for creating, starting and stopping a bot and for sending messages through a running bot.

Inheritance Hierarchy

System Object
CkSoftware.GroupMe.Sdk.Bot GroupMeBot

Namespace: CkSoftware.GroupMe.Sdk.Bot
Assembly: CkSoftware.GroupMe.Sdk.Bot (in CkSoftware.GroupMe.Sdk.Bot.dll) Version: 1.0.1.35397 (1.0.1.0)

Syntax

public class GroupMeBot

public class GroupMeBot

Public Class GroupMeBot

Public Class GroupMeBot

type GroupMeBot =  class end

type GroupMeBot =  class end

The GroupMeBot type exposes the following members.

Constructors

	Name	Description
	GroupMeBot(IWebApiAccess, BotData)	Instantiate a new GroupMeBot class with the given bot-data.
	GroupMeBot(IWebApiAccess, String, String)	Instantiates a new GroupMeBot class and creates a new bot with the given data.

Methods

	Name	Description
	DestroyBot	Destroys the currently assigned bot. The bot will no longer be available on GroupMe and needs to be recreated either using the GroupMe UI or using the StartBot command.
	DestroyBotAsync	Destroys the currently assigned bot asynchronous. The bot will no longer be available on GroupMe and needs to be recreated either using the GroupMe UI or using the StartBotAsync command.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SendMessage	Creates a new GroupMeBotSendMessage, ready to be sent on behalf of this bot. To send the message, call the Submit() or SubmitAsync() method.
	StartBot	Starts the bot using the currently assigned bot-data.
	StartBotAsync	Starts the bot using the currently assigned bot-data asynchronous.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WithAvatar	Defines that the current bot should contain a avatar.
	WithCallback	Defines that the current bot should contain a callback url.

Properties

	Name	Description
	Data	The currently assigned bot-data object, containing all GroupMe bot relevant data.