package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = {
  1. 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.

    *)
  2. 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.

    *)
  3. signature : string;
    (*

    The signature of the conference data. Generated 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.

    *)
  4. conferenceId : string;
    (*

    The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. The ID value is formed differently for each conference solution type:

    • eventHangout: ID is not set. (This conference type is deprecated.)
    • eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)
    • hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.
    • addOn: ID is defined by the third-party provider. Optional.
    *)
  5. parameters : ConferenceParameters.t;
    (*

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

    *)
  6. conferenceSolution : ConferenceSolution.t;
    (*

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

    *)
  7. 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.

    *)
}
val entryPoints : (t, EntryPoint.t list) GapiLens.t
val notes : (t, string) GapiLens.t
val signature : (t, string) GapiLens.t
val conferenceId : (t, string) GapiLens.t
val parameters : (t, ConferenceParameters.t) GapiLens.t
val conferenceSolution : (t, ConferenceSolution.t) GapiLens.t
val createRequest : (t, CreateConferenceRequest.t) 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