actions-on-google
Version:
Actions on Google Client Library for Node.js
120 lines • 3.69 kB
JavaScript
;
/**
* Copyright 2018 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.Available = exports.AvailableSurfaces = exports.AvailableSurfacesCapabilities = exports.Capabilities = exports.Surface = void 0;
class Surface {
/** @hidden */
constructor(surface = {}) {
this.capabilities = new Capabilities(surface.capabilities);
}
/**
* Checks if surface has an attribute like a capability
*
* @example
* ```javascript
*
* app.intent('Default Welcome Intent', conv => {
* if (conv.surface.has('actions.capability.AUDIO_OUTPUT')) {
* conv.ask('You can hear me! How are you?')
* } else {
* conv.ask('You can read this! How are you?')
* }
* })
* ```
*
* @param attribute An attribute like SurfaceCapability
* @public
*/
has(attribute) {
if (this.capabilities.has(attribute)) {
return true;
}
return false;
}
}
exports.Surface = Surface;
class Capabilities {
/** @hidden */
constructor(list = []) {
this.list = list;
}
/**
* Returns true if user device has a given surface capability.
* @public
*/
has(capability) {
return this.list.map(c => c.name).indexOf(capability) > -1;
}
}
exports.Capabilities = Capabilities;
class AvailableSurfacesCapabilities {
/** @hidden */
constructor(surfaces) {
this.surfaces = surfaces;
}
/**
* Returns true if user has an available surface which includes all given
* capabilities. Available surfaces capabilities may exist on surfaces other
* than that used for an ongoing conversation.
* @public
*/
has(capability) {
return (this.surfaces.findIndex(surface => surface.capabilities.has(capability)) >
-1);
}
}
exports.AvailableSurfacesCapabilities = AvailableSurfacesCapabilities;
class AvailableSurfaces {
/** @hidden */
constructor(list) {
this.list = list.map(surface => new Surface(surface));
this.capabilities = new AvailableSurfacesCapabilities(this.list);
}
/**
* Checks if available surfaces has an attribute like a capability
*
* @example
* ```javascript
*
* app.intent('Default Welcome Intent', conv => {
* if (conv.available.surfaces.has('actions.capability.SCREEN_OUTPUT')) {
* conv.ask('You have a device that can view images! How are you?')
* } else {
* conv.ask('You do not have a device that can view images! How are you?')
* }
* })
* ```
*
* @param attribute An attribute like SurfaceCapability
* @public
*/
has(attribute) {
if (this.capabilities.has(attribute)) {
return true;
}
return false;
}
}
exports.AvailableSurfaces = AvailableSurfaces;
class Available {
/** @hidden */
constructor(surfaces = []) {
this.surfaces = new AvailableSurfaces(surfaces);
}
}
exports.Available = Available;
//# sourceMappingURL=surface.js.map