Skip to content
This repository has been archived by the owner on Jul 21, 2020. It is now read-only.

Home

Jump to bottom
Jack Cook edited this page Mar 20, 2016 · 3 revisions

Welcome to the documentation for Beam's Swift API client! This is a relatively large library, and it is broken up into several major components:

  • Chat Client: Connects to Beam's chat servers, sending and receiving chat packets
  • Routes: Contain methods that interface with all of Beam's API endpoints
    • Achievements: Retrieves information about achievements
    • Channels: Retrieves and modifies channel data
    • Chat: Retrieves chat details, viewer data, and emoticons
    • Shop: Retrieves shop categories and items
    • Tetris: Retrieves tetris connection details
    • Users: Retrieves and modifies user data
  • Session: Authenticates and deals with user sessions
  • Tetris Client: Connects to a channel's tetris controls, sending and retrieving control updates
Clone this wiki locally