OLD | NEW |
(Empty) | |
| 1 // Copyright 2017 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. |
| 4 |
| 5 /** |
| 6 * This Polymer element contains the entire media router interface. It handles |
| 7 * hiding and showing specific components. |
| 8 * @record |
| 9 */ |
| 10 function MediaRouterContainerInterface() {} |
| 11 |
| 12 /** |
| 13 * The list of available sinks. |
| 14 * @type {!Array<!media_router.Sink>} |
| 15 */ |
| 16 MediaRouterContainerInterface.prototype.allSinks; |
| 17 |
| 18 /** |
| 19 * The list of CastModes to show. |
| 20 * @type {!Array<!media_router.CastMode>|undefined} |
| 21 */ |
| 22 MediaRouterContainerInterface.prototype.castModeList; |
| 23 |
| 24 /** |
| 25 * The URL to open when the device missing link is clicked. |
| 26 * @type {string|undefined} |
| 27 */ |
| 28 MediaRouterContainerInterface.prototype.deviceMissingUrl; |
| 29 |
| 30 /** |
| 31 * The URL to open when the cloud services pref learn more link is clicked. |
| 32 * @type {string|undefined} |
| 33 */ |
| 34 MediaRouterContainerInterface.prototype.firstRunFlowCloudPrefLearnMoreUrl; |
| 35 |
| 36 /** |
| 37 * The URL to open when the first run flow learn more link is clicked. |
| 38 * @type {string|undefined} |
| 39 */ |
| 40 MediaRouterContainerInterface.prototype.firstRunFlowLearnMoreUrl; |
| 41 |
| 42 /** |
| 43 * The header text for the sink list. |
| 44 * @type {string|undefined} |
| 45 */ |
| 46 MediaRouterContainerInterface.prototype.headerText; |
| 47 |
| 48 /** |
| 49 * The header text tooltip. This would be descriptive of the |
| 50 * source origin, whether a host name, tab URL, etc. |
| 51 * @type {string|undefined} |
| 52 */ |
| 53 MediaRouterContainerInterface.prototype.headerTextTooltip; |
| 54 |
| 55 /** |
| 56 * The issue to show. |
| 57 * @type {?media_router.Issue} |
| 58 */ |
| 59 MediaRouterContainerInterface.prototype.issue; |
| 60 |
| 61 /** |
| 62 * The list of current routes. |
| 63 * @type {!Array<!media_router.Route>|undefined} |
| 64 */ |
| 65 MediaRouterContainerInterface.prototype.routeList; |
| 66 |
| 67 /** |
| 68 * Whether the search input should be padded as if it were at the bottom of |
| 69 * the dialog. |
| 70 * @type {boolean} |
| 71 */ |
| 72 MediaRouterContainerInterface.prototype.searchUseBottomPadding; |
| 73 |
| 74 /** |
| 75 * Whether to show the user domain of sinks associated with identity. |
| 76 * @type {boolean|undefined} |
| 77 */ |
| 78 MediaRouterContainerInterface.prototype.showDomain; |
| 79 |
| 80 /** |
| 81 * Whether to show the first run flow. |
| 82 * @type {boolean|undefined} |
| 83 */ |
| 84 MediaRouterContainerInterface.prototype.showFirstRunFlow; |
| 85 |
| 86 /** |
| 87 * Whether to show the cloud preference setting in the first run flow. |
| 88 * @type {boolean|undefined} |
| 89 */ |
| 90 MediaRouterContainerInterface.prototype.showFirstRunFlowCloudPref; |
| 91 |
| 92 /** |
| 93 * Whether the WebUI route controls should be shown instead of the |
| 94 * extensionview in the route details view. |
| 95 * @type {boolean} |
| 96 */ |
| 97 MediaRouterContainerInterface.prototype.useWebUiRouteControls; |
| 98 |
| 99 /** |
| 100 * Fires a 'report-initial-action' event when the user takes their first |
| 101 * action after the dialog opens. Also fires a 'report-initial-action-close' |
| 102 * event if that initial action is to close the dialog. |
| 103 * @param {!media_router.MediaRouterUserAction} initialAction |
| 104 */ |
| 105 MediaRouterContainerInterface.prototype.maybeReportUserFirstAction = function( |
| 106 initialAction) {}; |
| 107 |
| 108 /** |
| 109 * Updates |currentView_| if the dialog had just opened and there's |
| 110 * only one local route. |
| 111 */ |
| 112 MediaRouterContainerInterface.prototype.maybeShowRouteDetailsOnOpen = |
| 113 function() {}; |
| 114 |
| 115 /** |
| 116 * Handles response of previous create route attempt. |
| 117 * @param {string} sinkId The ID of the sink to which the Media Route was |
| 118 * creating a route. |
| 119 * @param {?media_router.Route} route The newly created route that |
| 120 * corresponds to the sink if route creation succeeded; null otherwise. |
| 121 * @param {boolean} isForDisplay Whether or not |route| is for display. |
| 122 */ |
| 123 MediaRouterContainerInterface.prototype.onCreateRouteResponseReceived = |
| 124 function(sinkId, route, isForDisplay) {}; |
| 125 |
| 126 /** |
| 127 * Called when a search has completed up to route creation. |sinkId| |
| 128 * identifies the sink that should be in |allSinks|, if a sink was found. |
| 129 * @param {string} sinkId The ID of the sink that is the result of the |
| 130 * currently pending search. |
| 131 */ |
| 132 MediaRouterContainerInterface.prototype.onReceiveSearchResult = function( |
| 133 sinkId) {}; |
| 134 |
| 135 /** |
| 136 * Called when the connection to the route controller is invalidated. Switches |
| 137 * from route details view to the sink list view. |
| 138 */ |
| 139 MediaRouterContainerInterface.prototype.onRouteControllerInvalidated = |
| 140 function() {}; |
| 141 |
| 142 /** |
| 143 * Sets the selected cast mode to the one associated with |castModeType|, |
| 144 * and rebuilds sinks to reflect the change. |
| 145 * @param {number} castModeType The type of the selected cast mode. |
| 146 */ |
| 147 MediaRouterContainerInterface.prototype.selectCastMode = function( |
| 148 castModeType) {}; |
| 149 |
| 150 /** |
| 151 * Update the max dialog height and update the positioning of the elements. |
| 152 * @param {number} height The max height of the Media Router dialog. |
| 153 */ |
| 154 MediaRouterContainerInterface.prototype.updateMaxDialogHeight = function( |
| 155 height) {}; |
OLD | NEW |