Commits

Anonymous committed b8b4573 Draft

README

  • Participants
  • Parent commits f2f7fa9

Comments (0)

Files changed (1)

-ActionScript 3 Social Network API - универсальная прослойка для работы с API различных соцсетей из Flash-приложений. 
+ActionScript 3 Social Network API - универсальная библиотека для работы с API соцсетей из Flash-приложений. 
 
-Библиотека as3snapi основана на опыте работы с API популяных соцсетей наработанном в Igrostar (http://igrostar.com)
+
+ЛИЦЕНЗИЯ 
+
+BSD 
+
+
+ОСНОВНЫЕ ВОЗМОЖНОСТИ
+
+На данный момент реализованы базовые функции API: 
+* получение друзей; 
+* получение друзей в приложении; 
+* получение своего профиля; 
+* отображение окна приглашения друзей. 
+Из документации имеется код приложения sandbox (в репозитории) :)
+
+Список поддерживаемых соцсетей: 
+* http://vk.com - Вконтакте;
+* http://my.mail.ru - Мой мир;
+* http://odnoklassniki.ru - Одноклассники;
+* http://facebook.com - Facebook (черновая реализация);
+* mock - тестовая offline-сеть на основе конфиг-файла. Имеется возможность сделать сделать снимок данных с любой из вышеперечисленных сетей и использовать их оффлайн для отладки через mock сеть.
+В ближайших планах расширение этого списка.
+ 
+
+ОСОБЕНОСТИ
 
 Основные идеи заложенные в as3snapi:
-* можно использвать общий swf файл приложения для всех соцсетей;
-* приложение без изменений можно использовать и в собственном iframe и заливая на сервера соцсетей (my.mail.ru vk.com)
-* доступная соцсеть определяется автоматически на основе flashvars;
-* подключение новых сетей не должно требовать серьезных изменений кода приложения;
-* в приложение включается код только для используемых сетей;
-* максимальное повторное использование кода внутри библиотеки;
-* большинство сетей предоставлюят схожий API, для них библиотека предоставляет общий интерфейс;
-* в экзотических соцсетях любая привычная функция может отсутствовать (нет окна приглашения друзей, нет функции загрузки всех друзей, нет функции загрузки профиля по id и т.д.), код приложения должен быть готов к этому и иметь возможность проверить доступность функционала.
+* использовать единый swf файл приложения для всех соцсетей;
+* предоставлять возможность запуска приложения без изменений через iframe и непосредсвенно swf (my.mail.ru, vk.com)
+* определять доступную соцсеть автоматически, на основе flashvars;
+* включать в приложение код только для используемых сетей;
+* максимально повторно использовать код внутри библиотеки;
+* предоставлять общий интерфейс для схожего API разлиных сетей;
+* оставлять возможность прямого доступа к специфичным функциям соцсети;
+* предоставлять возможность работы в offline-режиме (mock-сеть);
+* быть "готовой ко всему". В экзотических соцсетях любая привычная функция может отсутствовать (нет окна приглашения друзей, нет функции загрузки всех друзей, нет функции загрузки профиля по id и т.д.), код приложения должен быть готов к этому и иметь возможность проверить доступность функционала.
 
 Особенности реализации:
 * Доступ к возможностям соцсетей осуществялется через механизм 'фич' (обычный ActionScript interface) подключаемых к общей 'шине' (примитивный IoC-контейнер);
 * Для доступа к специфичным возможностям модуль соцсети вводит свои собственные дополнительные 'фичи'; 
 * Модули сетей реализованы в виде отдельных плагинов. 
 
-Текущая реализация поддерживает: 
-* http://vk.com - Вконтакте;
-* http://my.mail.ru - Мой мир;
-* http://odnoklassniki.ru -Одноклассники ;
-* mock - тестовая offline сеть на основе конфиг-файла. Имеется возможность сделать сделать сномок данных с любой из вышеперечисленных сетей и использовать их оффлайн для отладки через mock сеть.
-В ближайших планах расширение этого списка.
 
-На данный момент сети поддерживают только базовые функции: 
-* получение друзей; 
-* получение друзей в приложении; 
-* получение своего профиля; 
-* отображение окна приглашения друзей. 
-На данный момент из документации имеется только код приложения sandbox (в репозитории) :)
+ПРИМЕРЫ ИСПОЛЬЗОВАНИЯ
 
 Собраную песочницу можно скачать отсюда:
 https://bitbucket.org/nitrobin/as3snapi/downloads
 http://cdn.bitbucket.org/nitrobin/as3snapi/downloads/as3snapi-sandbox-1.0.4-SNAPSHOT.swf
 Без параметров приложение запуститься в режиме mock;
 
-Библиотека находится в стадии активной разработки и API может быть изменен.
-
-Пример использования (инициализация API и загрузка своего профиля):
+Пример на ActionScript3 инициализации API и загрузки своего профиля:
 
 // as3snapi-sandbox/src/HelloWorld.as
 public class HelloWorld extends Sprite {
         appFriendsUids:[2],
         friendsUids:[2, 3]
     };
-}
+}
+
+
+ГДЕ ИСПОЛЬЗУЕТСЯ?
+
+Изначально библиотека разработана с прицелом на использование в домашних экспериментальных проектах, но нашла применение и за их пределами. :) 
+В настоящее время используется в проекте "Мастера войны" (http://vk.com/app2699907) компании "Igrostar" (http://igrostar.com)
+
+
+АВТОР
+2012 (c) Евгений Веретенников ["nitro.bin","gmail.com"].join("@")
+