Home | History | Annotate | Download | only in api
      1 // Copyright 2013 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 // The <code>chrome.hangoutsPrivate</code> API is used by Google Hangouts to
      6 // wait on a request from Chrome to start a hangout.
      7 // TODO(rkc): This API is temporary. We are working on plans which include
      8 // replacing this with a scheme based solution which might be implemented
      9 // using registerProtocolHandler, but we are still finishing that design.
     10 // See crbug.com/306672
     11 namespace hangoutsPrivate {
     12 
     13   enum HangoutType {chat, video, audio};
     14 
     15   dictionary User {
     16     // GAIA obfuscated id of the user.
     17     DOMString id;
     18   };
     19 
     20   dictionary HangoutRequest {
     21     // Email of the user sending this request. This has to match the logged in
     22     // user otherwise the hangout will not be opened.
     23     DOMString from;
     24 
     25     // A list of users with whom to start this hangout with.
     26     User[] to;
     27 
     28     // Type of hangout request.
     29     HangoutType type;
     30   };
     31 
     32   interface Events {
     33     // Fired when Chrome wants to request a new hangout be opened up with a
     34     // user (or set of users).
     35     static void onHangoutRequested(HangoutRequest request);
     36   };
     37 };
     38