coachBot

codioIDE. Namespace

coachBot

Description:
  • Coach Bot API methods
Source:

Interfaces

CoachBotAskCallbackData
CoachBotCallOptions
CoachBotContext
CoachBotCustomRequestData
CoachBotMenuItem
CoachBotMenuItemCustomData
CoachBotMenuStep

Members

(static, readonly) ACTIONS_TYPES :string

Source:
Properties:
Name Type Description
REQUEST string Make server request
INPUT string Show user input
CALLBACK string Call custom callback
Type:
  • string

(static, readonly) COACH_BOT_REQUEST_TYPE :string

Source:
Properties:
Name Type Description
SUMMARIZE string Summarize what I need to do
EXPLAIN_ERROR string Explain an error
NEXT_TO_DO string Provide a hint on what to do next
CUSTOM string Custom request type
Type:
  • string

Methods

(static) ask(data, onDone)

Description:
  • Ask bot
Source:
Parameters:
Name Type Description
data codioIDE.coachBot.CoachBotCustomRequestData request data
onDone AskBotDoneCallback on request done callback

(static) call(callOptionsopt)

Description:
  • Opens Coach Bot and calls action
Source:
Parameters:
Name Type Attributes Description
callOptions codioIDE.coachBot.CoachBotCallOptions <optional>
 optional call action options

(static) close()

Description:
  • Closes Coach Bot
Source:

(static) deregister(actionId)

Description:
  • Deregister coach bot menu item
Source:
Parameters:
Name Type Description
actionId string action id to deregister

(async, static) getContext() → {codioIDE.coachBot.CoachBotContext}

Description:
  • Get coach bot context
Source:
Returns:
Type
codioIDE.coachBot.CoachBotContext

(static) hideTooltip()

Description:
  • Hide Coach bot tooltip
Source:

(static) open(callOptionsopt)

Description:
  • Opens Coach Bot
Source:
Parameters:
Name Type Attributes Description
callOptions codioIDE.coachBot.CoachBotCallOptions <optional>
 optional call action options

(static) register(menuItem)

Description:
  • Register coach bot menu item
Source:
Parameters:
Name Type Description
menuItem codioIDE.coachBot.CoachBotMenuItem coach bot menu item

(static) showTooltip(message, callback)

Description:
  • Show Coach bot tooltip
Source:
Parameters:
Name Type Description
message string tooltip message
callback callback executes when tooltip clicked

(static) write(text)

Description:
  • Show custom message in the coach bot
Source:
Parameters:
Name Type Description
text string plain text

Type Definitions

AskBotDoneCallback(result)

Description:
  • Ask bot done callback
Source:
Parameters:
Name Type Description
result codioIDE.coachBot.CoachBotAskCallbackData done result

callback()

Description:
  • Set tooltip callback
Source: