File: Games\GamesByEmail.GameForm.js

GamesByEmail
Class GameForm

Object
  
 
 
GamesByEmail.GameForm

All Implemented Interfaces:

Class, Elemental, Resourceful, Server

Direct Known Subclasses:

AtaxxGameForm, AtollGameForm, BackgammonGameForm, BegirdGameForm, ByteGameForm, CageGameForm, CaptureTheFlagGameForm, CephalopodGameForm, CheckersGameForm, ChessGameForm, ChineseCheckersGameForm, CopolymerGameForm, CrosswayGameForm, DiffusionGameForm, DipoleGameForm, EmpiresGameForm, GambitGameForm, GomokuGameForm, ImpasseGameForm, Link4GameForm, McCooeyHexChessGameForm, MergersGameForm, OmegaChessGameForm, OustGameForm, PalisadeGameForm, PlateauGameForm, PoliticsGameForm, QuadratureGameForm, ReflektitGameForm, ReversiGameForm, RiveGameForm, RushGameForm, ScribeGameForm, SnagGameForm, TanboGameForm, TicTacToeGameForm, TriversiGameForm, TwixtGameForm, Viktory2GameForm, WW2GameForm, XGameForm, XiangqiGameForm, ZertzGameForm, GameForm

GamesByEmail.GameForm

implements Foundation.Class, Foundation.Elemental, Foundation.Resourceful, Foundation.Server

Constructor Summary
GamesByEmail.GameForm(settings, requestSessionInfo)

Enum Summary
static  GAME_TYPE
static  OPEN_MODE
static  PLAYER_MODE

Field Summary
static  defaultSettings
static  resourcePack

Fields inherited from Foundation.Elemental
$Foundation_$registry_index

Method Summary
static  addCreateGameFormToPage(elementId, settings)
 attachHelpers(index)
 attemptLogin(passive, event)
 cancelJoin(index)
 cancelRecommend(index)
 catchResponseError(url, postData, responseText, errorObject)
static  changeDomain(domain, extension)
static  createGameForm(settings)
 createGameHtml(htmlBuilder)
 createGamePlayButtonHtml(htmlBuilder)
 createGamePlayerHtml(index, htmlBuilder)
 createGamePlayersHtml(htmlBuilder)
 createPlayer(title, id, mode, rank, playerId)
 dispose()
static  findClassForGameType(gameType)
 focusOnPlayer(index, delayed)
 gameBoardUrl(path)
 getAvailableGameTypes()
 getDefaultTitle()
 getHtml()
 getOurEmail()
 getPlayUrl(playerId)
 gleanGame(game)
 handleBuddyResponse(response)
static  handleBuddyResponse(response)
 handleJoinResponse(response)
 handleJoinedResponse(response)
 handlePlayResponse(response)
 handleRecommendResponse(response)
 handleRequestGameResponse(response)
static  importDefaultSettings(gameForm)
 importSettings(settings, clearCollections)
 inviteSomeone(index)
 isAvailableGameType(gameType)
static  isEmailAddressFormatValid(emailAddress, allowMultiple, allowEmpty)
static  isForGameType(gameType)
 isPlayerShownOnJoin(playerIndex)
 joinGame(index)
 joinGameHtml(htmlBuilder)
 joinGamePlayerHtml(index, htmlBuilder)
 joinGamePlayersHtml(htmlBuilder)
 joinThisGame(index)
 jsSerialize(stringBuilder)
 numPlayersOnChange(Num)
 onCancelJoin(playerIndex)
 onCreate()
 onCreateSuccess(playerIds)
 onGameTypeChange(gameType)
 onJoin(playerIndex)
 onJoinLockSuccess(playerIndices)
 onJoinSuccess(playerIds)
 onMicroLoginShow()
 onRequestJoinLock(playerIndex)
 openInvitation(index)
 play(event)
 playThisTeam(index)
 playerModeBack(index)
 positionsAvailableToJoin()
 recommendThisGame(index)
 recommendingGame(index)
 recordAll()
 recordFriend(index)
 recordMe(index)
 requestGame(gameId)
 requestSessionInfo()
 responseErrorReported(message)
 sendPlay(event)
 setPlayer(index, info)
 setShowGameControl(control, methodName)
 setStartAnotherGamePlayers(userInfo)
 showGame()
 startNewGame()
 teamTitle(index)
 updateEmailStyle(index)
 updateJoinForm()
 updatePlayerCreate(index)
 updatePlayerJoin(index)
static  writeJoinGameFormToPage(gameId, settings)

Methods inherited from Foundation.Class
getTypePath, isInstanceOf

Methods inherited from Foundation.Elemental
attachEvent, detachEvent, elementId, event, getById, getElement, getElementValue, getElements, getFirst, getNext, parseElementId, processHtml, processHtml

Methods inherited from Foundation.Resourceful
resource, resource, resourceUrl, resourceUrl

Methods inherited from Foundation.Server
server, serverSerialized, serverSynchronous

Constructor Detail

GameForm

GamesByEmail.GameForm(settings,
                      requestSessionInfo)
Parameters: 
settings - 

requestSessionInfo -

Enum Detail

GAME_TYPE

static GAME_TYPE
Values: 
CHESS - 

BACKGAMMON - 

CHECKERS - 

REVERSI - 

LINK_4 - 

ATAXX - 

TWIXT - 

XIANGQI - 

DARK_CHESS - 

OMEGA_CHESS - 

DARK_OMEGA_CHESS - 

CHINESE_CHECKERS - 

TRIVERSI - 

DEADGAMMON - 

HYPERGAMMON - 

NACKGAMMON - 

GAMBIT - 

DARK_GAMBIT - 

BLIND_GAMBIT - 

SPY_GAMBIT - 

GIPF - 

ZERTZ - 

DVONN - 

DARK_XIANGQI - 

TIC_TAC_TOE - 

REFLEKTIT - 

BLIND_TRIVERSI - 

MCCOOEY_HEX_CHESS - 

DARK_MCCOOEY_HEX_CHESS - 

GO - 

GO_13X13 - 

GO_9X9 - 

POLITICS - 

WW2 - 

YINSH - 

BLITZ_YINSH - 

BYTE_8X8 - 

BYTE_10X10 - 

SNAG - 

ELUDE - 

DARK_ELUDE - 

PLOT - 

DARK_PLOT - 

BLIND_PLOT - 

MERGERS - 

FIVES - 

DARK_ATAXX - 

NINE_MENS_MORRIS - 

TANBO - 

DIPOLE - 

CEPHALOPOD - 

ATOLL - 

RUSH - 

CROSSWAY - 

CROSSWAY_PIED - 

SCRIBE - 

SUPERGLYPH_SCRIBE - 

DIFFUSION - 

COPOLYMER - 

OUST_SQUARE_OLD - 

BEGIRD - 

BEGIRD_PIED - 

PALISADE - 

IMPASSE - 

QUADRATURE - 

MECHA - 

EMPIRES - 

LARIAT - 

LARIAT_PIED - 

VIKTORY2 - 

ATOLL_PIED - 

LOOPHOLE_2D - 

GOMOKU - 

PLATEAU - 

CAPTURE_THE_FLAG - 

BATTLE_BOATS - 

CAGE - 

OUST_SQUARE - 

OUST_HEX - 

FLUME_SQUARE - 

FLUME_SQUARE_PIED - 

FLUME_HEX - 

FLUME_HEX_PIED - 

FRACTAL - 

X - 

RIVE - 

PHALANX -

OPEN_MODE

static OPEN_MODE
Values: 
ADD_TO_PAGE - 

OPEN_NEW_WINDOW - 

OPEN_IN_CONTROL -

PLAYER_MODE

static PLAYER_MODE
Values: 
UNKNOWN - 

ME - 

SPECIFIC - 

UNCHANGEABLE - 

OPEN_OR_INVITE - 

OPEN - 

INVITE - 

JOIN - 

LOCKED - 

RECOMMEND - 

RECOMMENDING - 

UNCHANGEABLE_ME -

Field Detail

defaultSettings

static defaultSettings

resourcePack

static resourcePack

Method Detail

addCreateGameFormToPage

static addCreateGameFormToPage(elementId,
                               settings)
Parameters: 
elementId - 

settings -

attachHelpers

attachHelpers(index)
Parameters: 
index -

attemptLogin

attemptLogin(passive,
             event)
Parameters: 
passive - 

event -

cancelJoin

cancelJoin(index)
Parameters: 
index -

cancelRecommend

cancelRecommend(index)
Parameters: 
index -

catchResponseError

catchResponseError(url,
                   postData,
                   responseText,
                   errorObject)
Parameters: 
url - 

postData - 

responseText - 

errorObject -

changeDomain

static changeDomain(domain,
                    extension)
Parameters: 
domain - 

extension -

createGameForm

static createGameForm(settings)
Parameters: 
settings -

createGameHtml

createGameHtml(htmlBuilder)
Parameters: 
htmlBuilder -

createGamePlayButtonHtml

createGamePlayButtonHtml(htmlBuilder)
Parameters: 
htmlBuilder -

createGamePlayerHtml

createGamePlayerHtml(index,
                     htmlBuilder)
Parameters: 
index - 

htmlBuilder -

createGamePlayersHtml

createGamePlayersHtml(htmlBuilder)
Parameters: 
htmlBuilder -

createPlayer

createPlayer(title,
             id,
             mode,
             rank,
             playerId)
Parameters: 
title - 

id - 

mode - 

rank - 

playerId -

dispose

dispose()
Overrides:
dispose in class Class

findClassForGameType

static findClassForGameType(gameType)
Parameters: 
gameType -

focusOnPlayer

focusOnPlayer(index,
              delayed)
Parameters: 
index - 

delayed -

gameBoardUrl

gameBoardUrl(path)
Parameters: 
path -

getAvailableGameTypes

getAvailableGameTypes()

getDefaultTitle

getDefaultTitle()

getHtml

getHtml()

getOurEmail

getOurEmail()

getPlayUrl

getPlayUrl(playerId)
Parameters: 
playerId -

gleanGame

gleanGame(game)
Parameters: 
game -

handleBuddyResponse

handleBuddyResponse(response)
Parameters: 
response -

handleBuddyResponse

static handleBuddyResponse(response)
Parameters: 
response -

handleJoinResponse

handleJoinResponse(response)
Parameters: 
response -

handleJoinedResponse

handleJoinedResponse(response)
Parameters: 
response -

handlePlayResponse

handlePlayResponse(response)
Parameters: 
response -

handleRecommendResponse

handleRecommendResponse(response)
Parameters: 
response -

handleRequestGameResponse

handleRequestGameResponse(response)
Parameters: 
response -

importDefaultSettings

static importDefaultSettings(gameForm)
Parameters: 
gameForm -

importSettings

importSettings(settings,
               clearCollections)
Parameters: 
settings - 

clearCollections -

inviteSomeone

inviteSomeone(index)
Parameters: 
index -

isAvailableGameType

isAvailableGameType(gameType)
Parameters: 
gameType -

isEmailAddressFormatValid

static isEmailAddressFormatValid(emailAddress,
                                 allowMultiple,
                                 allowEmpty)
Parameters: 
emailAddress - 

allowMultiple - 

allowEmpty -

isForGameType

static isForGameType(gameType)
Parameters: 
gameType -

isPlayerShownOnJoin

isPlayerShownOnJoin(playerIndex)
Parameters: 
playerIndex -

joinGame

joinGame(index)
Parameters: 
index -

joinGameHtml

joinGameHtml(htmlBuilder)
Parameters: 
htmlBuilder -

joinGamePlayerHtml

joinGamePlayerHtml(index,
                   htmlBuilder)
Parameters: 
index - 

htmlBuilder -

joinGamePlayersHtml

joinGamePlayersHtml(htmlBuilder)
Parameters: 
htmlBuilder -

joinThisGame

joinThisGame(index)
Parameters: 
index -

jsSerialize

jsSerialize(stringBuilder)
Parameters: 
stringBuilder -

numPlayersOnChange

numPlayersOnChange(Num)
Parameters: 
Num -

onCancelJoin

onCancelJoin(playerIndex)
Parameters: 
playerIndex -

onCreate

onCreate()

onCreateSuccess

onCreateSuccess(playerIds)
Parameters: 
playerIds -

onGameTypeChange

onGameTypeChange(gameType)
Parameters: 
gameType -

onJoin

onJoin(playerIndex)
Parameters: 
playerIndex -

onJoinLockSuccess

onJoinLockSuccess(playerIndices)
Parameters: 
playerIndices -

onJoinSuccess

onJoinSuccess(playerIds)
Parameters: 
playerIds -

onMicroLoginShow

onMicroLoginShow()

onRequestJoinLock

onRequestJoinLock(playerIndex)
Parameters: 
playerIndex -

openInvitation

openInvitation(index)
Parameters: 
index -

play

play(event)
Parameters: 
event -

playThisTeam

playThisTeam(index)
Parameters: 
index -

playerModeBack

playerModeBack(index)
Parameters: 
index -

positionsAvailableToJoin

positionsAvailableToJoin()

recommendThisGame

recommendThisGame(index)
Parameters: 
index -

recommendingGame

recommendingGame(index)
Parameters: 
index -

recordAll

recordAll()

recordFriend

recordFriend(index)
Parameters: 
index -

recordMe

recordMe(index)
Parameters: 
index -

requestGame

requestGame(gameId)
Parameters: 
gameId -

requestSessionInfo

requestSessionInfo()

responseErrorReported

responseErrorReported(message)
Parameters: 
message -

sendPlay

sendPlay(event)
Parameters: 
event -

setPlayer

setPlayer(index,
          info)
Parameters: 
index - 

info -

setShowGameControl

setShowGameControl(control,
                   methodName)
Parameters: 
control - 

methodName -

setStartAnotherGamePlayers

setStartAnotherGamePlayers(userInfo)
Parameters: 
userInfo -

showGame

showGame()

startNewGame

startNewGame()

teamTitle

teamTitle(index)
Parameters: 
index -

updateEmailStyle

updateEmailStyle(index)
Parameters: 
index -

updateJoinForm

updateJoinForm()

updatePlayerCreate

updatePlayerCreate(index)
Parameters: 
index -

updatePlayerJoin

updatePlayerJoin(index)
Parameters: 
index -

writeJoinGameFormToPage

static writeJoinGameFormToPage(gameId,
                               settings)
Parameters: 
gameId - 

settings -