Difference between revisions of "IGB Javascript Wish List"

Revision as of 11:58, 23 October 2009

With Dominion releasing a new IGB; here is a compiled list of all JavaScript functionality that is desired by 3rd party developers.

Current Functionality can be found here.

Current Planned Functions

This is a tentative list based on CCP Ronin comments (src)

• javascript:CCPEVE.ShowInfo(typeID) - implemented
• javascript:CCPEVE.ShowRoute(systemID) - implemented as CCPEVE.showRouteTo
• javascript:CCPEVE.ShowMap(systemID) - implemented
• javascript:CCPEVE.ViewFitting(???) - implemented as CCPEVE.showFitting
• javascript:CCPEVE.AskForTrust() - imlemented as CCPEVE.requestTrust(trustableUrl)

Desired Functions to Interact with the UI

Assumption is that all calls will open the appropriate window or dialog to allow the user to edit/accept the action. No calls will actually perform an action beyond this.

• Money
  • javascript:CCPEVE.GiveMoney(characterID, amount, description)
  • javascript:CCPEVE.GiveMoneyFromCorp(characterID, amount, description, walletID)
• Buddy List
  • javascript:CCPEVE.AddBuddy(characterID)
• Mail & Chat
  • javascript:CCPEVE.NewMail(characterID, subject, body)
  • javascript:CCPEVE.NewGroupMail(groupID, subject, body)
  • javascript:CCPEVE.JoinMailList(ID) - implemented as CCPEVE.joinMailingList
  • javascript:CCPEVE.LeaveMailList(ID)
  • javascript:CCPEVE.JoinChatChannel(ID) - implemented as CCPEVE.joinChannel
  • javascript:CCPEVE.LeaveChatChannel(ID)
  • javascript:CCPEVE.StartConversation(characterID)
• Contracts
  • javascript:CCPEVE.ShowContract(contractID) - implemented
  • javascript:CCPEVE.NewCourierContract(sourceStationID, listOfItemIDs, targetStationID, collateral, payment)
  • javascript:CCPEVE.NewPrivateCourierContract(playerID, sourceStationID, listOfItemIDs, targetStationID, collateral, payment)
  • javascript:CCPEVE.NewPrivateItemExchangeContract(playerID, stationID, listOfItemIDs, payment)

    intended to show the last page of the contract wizard (Summary) with the arguments prefilled

  • javascript:CCPEVE.GetContracts(searchstring, [regionID],[charachterID],[TypeID],[?])

    intended to show the Contracts window with the arguments prefilled. Autosearch not enabled as that would override a users "Ok" capability, aka "Search"

• Overview
  • javascript:CCPEVE.SaveOverviewSetting(xml)
• Market
  • javascript:Client.ShowMarketInfo(typeID) - implemented as CCPEVE.showMarketDetails
• Starmap
  • javascript:CCPEVE.SetAutoPilotDestination(systemID) - implemented as CCPEVE.setDestination
  • javascript:CCPEVE.ClearAutoPilotDestination()
  • javascript:CCPEVE.OptimizeAutoPilotRoute()
• Standings
  • javascript:CCPEVE.EditStandings(characterID, newStanding, reason)
  • javascript:CCPEVE.EditCorpStandings(???)
• Fleets
  • javascript:CCPEVE.JoinFleet(fleetID)
  • javascript:CCPEVE.LeaveFleet()
  • javascript:CCPEVE.AddToWatchList(characterID)
• Other
  • javascript:CCPEVE.ShowInfo(any ID) - implemented for type IDs (with optional second parameter for specific item IDs)
  • javascript:CCPEVE.ShowContextMenu(anyID, x, y)

    where x and y are offset from IGB window.

Desired Functions to Retrieve Information

• Mail & Chat
  • javascript:CCPEVE.IsSubscribedToMailList(ID)
  • javascript:CCPEVE.GetSubscribedMailLists()
  • javascript:CCPEVE.HasJoinedChannel(ID)
  • javascript:CCPEVE.GetJoinedChannels()
• Starmap
  • javascript:CCPEVE.GetJumpCount(systemID,...,systemID)

    returns an object array list where the object is composed of (systemID,jumpCount) (src)

  • javascript:CCPEVE.GetAutoPilotRoute()
  • javascript:CCPEVE.IsSystemOnAutoPilotRoute(systemID)
• API Key
  • javascript:CCPEVE.GetLimitedApiKey()

    pops up a confirmation window and (if approved) returns the limited API key of the user

  • javascript:CCPEVE.GetFullApiKey()

    pops up a red flashing confirmation window and (if approved) returns the full API key of the user

• Ship Fitting
  • javascript:CCPEVE.GetShipFitting()

    pops up a confirmation window and (if approved) returns the complete ship fitting (possibly Ship DNA string formatted)

• Fleets
  • javascript:CCPEVE.GetFleet()

    returns the id of the current fleet your in.

Desired Events

Some events would also like to be available so that a JavaScript function can be assigned to them. This would allow for more complex AJAX functions to occur between a website and the IGB.

• CCPEVE.OnJump (alternatively Client.OnSessionChange)

  SessionChangeArguments containing the information available in the headers.

• CCPEVE.OnDrop

  Drop arguments containing: label, typeID, itemID, quantity, ... The idea behind OnDrop is that items such as systems, contracts, pilots, ships, fittings etc can be dragged around and linked in chat text. So should those same items be able to be dragged into an IGB window and get properly referenced.