Bixby Developer Center

References

action-endpoint

optionalmultiple allowedvalue required

The outer key for an individual endpoint declaration. You can have multiple action-endpoint declarations within a single action-endpoints key.

Example

endpoints {

action-endpoints {
action-endpoint (MakeReservation) {
accepted-inputs (order, $vivContext)
local-endpoint (book/MakeReservation.js)
}

action-endpoint (CreateOrder) {
accepted-inputs (item, buyer)
local-endpoint (book/CreateOrder.js)
}

action-endpoint (UpdateOrder) {
accepted-inputs (order, changedItem, buyer)
local-endpoint (book/UpdateOrder.js)
}

action-endpoint (SelectPod) {
accepted-inputs (pods, podName)
local-endpoint (book/SelectPod.js)
}

action-endpoint (CreateItem) {
accepted-inputs (spaceResort, numberOfAstronauts, dateInterval, pod)
local-endpoint (book/CreateItem.js)
}

action-endpoint (FindPods) {
accepted-inputs (spaceResort, numberOfAstronauts, dateInterval, $vivContext)
local-endpoint (book/FindPods.js)
}

action-endpoint (CreateChangedItem) {
accepted-inputs (order, numberOfAstronauts, dateInterval, pod)
local-endpoint (book/CreateChangedItem.js)
}

action-endpoint (GetPossibleNumberOfAstronauts) {
accepted-inputs ()
local-endpoint (book/GetPossibleNumberOfAstronauts.js)
}

action-endpoint (ConstructDateIntervalFromDateTimeExpression) {
accepted-inputs (dateTimeExpression)
local-endpoint (book/ConstructDateIntervalFromDateTimeExpression.js)
}

action-endpoint (CheckStatus) {
accepted-inputs (receipt)
local-endpoint ("book/CheckStatus.js")
}

action-endpoint (CancelOrder) {
accepted-inputs (order)
local-endpoint ("book/CancelOrder.js")
}

action-endpoint (CancelCommittedOrder) {
accepted-inputs (receipt)
local-endpoint ("book/CancelCommittedOrder.js")
}

action-endpoint (FindLastReceipt) {
accepted-inputs ()
local-endpoint ("book/FindLastReceipt.js")
}

}

}

View master on GitHub

Child Keys

accepted-inputs
optional
Comma-separated list of named inputs that this endpoint accepts
authorization
optional
Specifies which authorization method to use, if any
local-endpoint
optional
The filename of the local endpoint (the local JavaScript file)
payment-methods
optional
Defines the acceptable payment methods users can pay with in your capsule
remote-endpoint
optional
The URL of the remote-endpoint
required-permissions
optional
A block key that declares if an action-endpoint requires one (or more) types of permissions