alexa

Documentation

Index

• func ClearSession(sessionID string)
• func CountItem(echoRequest *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func CreateLoadout(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func CurrentTrialsMap(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func CurrentTrialsWeek(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func DestinyJoke(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func EquipNamedLoadout(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func HelpPrompt(echoRequest *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func InitEnv(redisURL string)
• func MaxPower(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func PersonalTopWeapons(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func PopularWeaponTypes(echoRequest *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func PopularWeapons(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func SaveSession(session *Session)
• func TransferItem(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func UnloadEngrams(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• func WelcomePrompt(echoRequest *skillserver.EchoRequest) (response *skillserver.EchoResponse)
• type Handler
  • func AuthWrapper(handler Handler) Handler
• type Session
  • func GetSession(sessionID string) (session *Session)

Functions

func ClearSession

func ClearSession(sessionID string)

ClearSession will remove the specified session from the local cache, this will be done when the user completes a full request session.

func CountItem

func CountItem(echoRequest *skillserver.EchoRequest) (response *skillserver.EchoResponse)

CountItem calls the Bungie API to see count the number of Items on all characters and in the vault.

func CreateLoadout

func CreateLoadout(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

CreateLoadout will determine the user's current character and create a new loadout based on their currently equipped items. This loadout is then serialized and persisted to a persistent store.

func CurrentTrialsMap

func CurrentTrialsMap(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

CurrentTrialsMap will return a brief description of the current map in the active Trials of Osiris week.

func CurrentTrialsWeek

func CurrentTrialsWeek(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

CurrentTrialsWeek will return a brief description of the current map in the active Trials of Osiris week.

func DestinyJoke

func DestinyJoke(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

DestinyJoke will return the desired text for a random joke from the database.

func EquipNamedLoadout

func EquipNamedLoadout(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

func HelpPrompt

func HelpPrompt(echoRequest *skillserver.EchoRequest) (response *skillserver.EchoResponse)

HelpPrompt provides the required information to satisfy the HelpIntent built-in Alexa intent. This should provider information to the user to let them know what the skill can do without providing exact commands.

func InitEnv

func InitEnv(redisURL string)

InitEnv provides a package level initialization point for any work that is environment specific

func MaxPower

func MaxPower(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

MaxPower will equip the loadout on the current character that provides the maximum amount of power.

func PersonalTopWeapons

func PersonalTopWeapons(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

PersonalTopWeapons will check Trials Report for the most used weapons for the current user.

func PopularWeaponTypes

func PopularWeaponTypes(echoRequest *skillserver.EchoRequest) (response *skillserver.EchoResponse)

PopularWeaponTypes will return info about what classes of weapons are getting the most kills in Trials of Osiris.

func PopularWeapons

func PopularWeapons(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

PopularWeapons will check Trials Report for the most popular specific weapons for the current week.

func SaveSession

func SaveSession(session *Session)

SaveSession will persist the given session to the cache. This will allow support for long running Alexa sessions that continually prompt the user for more information.

func TransferItem

func TransferItem(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

TransferItem will attempt to transfer either a specific quantity or all of a specific item to a specified character. The item name and destination are the required fields. The quantity and source are optional.

func UnloadEngrams

func UnloadEngrams(request *skillserver.EchoRequest) (response *skillserver.EchoResponse)

UnloadEngrams will take all engrams on all of the current user's characters and transfer them all to the vault to allow the player to continue farming.

func WelcomePrompt

func WelcomePrompt(echoRequest *skillserver.EchoRequest) (response *skillserver.EchoResponse)

WelcomePrompt is responsible for prompting the user with information about what they can ask the skill to do.

Types

type Handler

type Handler func(*skillserver.EchoRequest) *skillserver.EchoResponse

Handler is the type of function that should be used to respond to a specific intent.

func AuthWrapper

func AuthWrapper(handler Handler) Handler

AuthWrapper is a handler function wrapper that will fail the chain of handlers if an access token was not provided as part of the Alexa request

type Session

type Session struct {
	ID                   string
	Action               string
	ItemName             string
	DestinationClassHash int
	SourceClassHash      int
	Quantity             int
}

Session is responsible for storing information related to a specific skill invocation. A session will remain open if the LaunchRequest was received.

func GetSession

func GetSession(sessionID string) (session *Session)

GetSession will attempt to read a session from the cache, if an existing one is not found, an empty session will be created with the specified sessionID.