package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = {
  1. conferenceId : string;
    (*

    The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types:

    • "eventHangout": unset.
    • "eventNamedHangout": the name of the Hangout.
    • "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
    *)
  2. conferenceSolution : ConferenceSolution.t;
    (*

    The conference solution, such as Hangouts or Hangouts Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required.

    *)
  3. createRequest : CreateConferenceRequest.t;
    (*

    A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. Either conferenceSolution and at least one entryPoint, or createRequest is required.

    *)
  4. entryPoints : EntryPoint.t list;
    (*

    Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest is required.

    *)
  5. notes : string;
    (*

    Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.

    *)
  6. parameters : ConferenceParameters.t;
    (*

    Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

    *)
  7. signature : string;
    (*

    The signature of the conference data. Genereated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. Unset for a conference with a failed create request. Optional for a conference with a pending create request.

    *)
}
val conferenceId : (t, string) GapiLens.t
val conferenceSolution : (t, ConferenceSolution.t) GapiLens.t
val createRequest : (t, CreateConferenceRequest.t) GapiLens.t
val entryPoints : (t, EntryPoint.t list) GapiLens.t
val notes : (t, string) GapiLens.t
val parameters : (t, ConferenceParameters.t) GapiLens.t
val signature : (t, string) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t