Location: PHPKode > projects > SteelBot > steelbot/include/interfaces/isteelbotprotocol.interface.php
<?php

/**
 * ISteelbotProtocol interface for SteelBot
 * 
 * http://steelbot.net
 * 
 * @author N3x^0r
 * @version 2.0.3
 * 
 * 
 */

/**
 * Интерфейс доступа к протоколу IM-системы
 *
 * Для работы бота необходимо и достаточно наличия этих функций.
 * 
 */
interface ISteelBotProtocol {

/**
 * Инициализация драйвера.
 *
 */
static function Init();
    
/**
 * Получить информацию о протоколе
 *
 * @return array(
 *      'version' => версия драйвера
 *      'name' => имя протокола
 * )
 */
static function GetProtoInfo();
/**
 * Подключиться к серверу
 *
 * 
 * @return bool
 */
static function Connect();

/**
 * Отключиться от сервера
 *
 */
static function Disconnect();

/**
 * Проверить, находится ли бот в онлайне
 *
 * @return bool
 */
static function Connected();

/**
 * Получить пришедшее сообщение
 *
 * 
 * @return bool
 */
static function GetMessage();

/**
 * Какая-либо информация в случае возникновения ошибки.
 * 
 * 
 * @return mixed info - любая информация
 *
 */
static function Error();

/**
 * Послать сообщение
 *
 * @param string $text - текст сообщения
 * @param string $to - ID человека в IM системе, на 
 * который надо отсылать сообщение. Если передается
 * false, то сообщение должно быть отправлено приславшему команду.          
 */
static function Msg($text,$touin = false);

/**
 * Установить IM-статус бота.
 *
 * @param string $status
 */
static function SetStatus($status);

/**
 * Проверить, является ли строка записью IM-адреса в этом протоколе.
 *
 * @param string $string
 * @return bool
 */
static function IsIMAccount($string);

/**
 * Проверить, входит ли указанный аккаунт в 
 * список администраторских.
 *
 * @param string $account
 */
static function IsAdmin($account);

/**
 * Возвращает уникальный идентификатор бота в IM-системе
 * (например, UIN или JID, на котором он запущен)
 */
static function BotId();

}
Return current item: SteelBot