package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module GapiSheetsV4Model.ProtectedRangeSource

Sourcetype t = {
  1. protectedRangeId : int;
    (*

    The ID of the protected range. This field is read-only.

    *)
  2. range : GridRange.t;
    (*

    The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id or table_id may be set.

    *)
  3. namedRangeId : string;
    (*

    The named range this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.

    *)
  4. tableId : string;
    (*

    The table this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.

    *)
  5. description : string;
    (*

    The description of this protected range.

    *)
  6. warningOnly : bool;
    (*

    True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors are ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document.

    *)
  7. requestingUserCanEdit : bool;
    (*

    True if the user who requested this protected range can edit the protected area. This field is read-only.

    *)
  8. unprotectedRanges : GridRange.t list;
    (*

    The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets.

    *)
  9. editors : Editors.t;
    (*

    The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warning_only protection.

    *)
}
Sourceval protectedRangeId : (t, int) GapiLens.t
Sourceval namedRangeId : (t, string) GapiLens.t
Sourceval tableId : (t, string) GapiLens.t
Sourceval description : (t, string) GapiLens.t
Sourceval warningOnly : (t, bool) GapiLens.t
Sourceval requestingUserCanEdit : (t, bool) GapiLens.t
Sourceval unprotectedRanges : (t, GridRange.t list) GapiLens.t
Sourceval editors : (t, Editors.t) GapiLens.t
Sourceval empty : t
Sourceval render : t -> GapiJson.json_data_model list
Sourceval to_data_model : t -> GapiJson.json_data_model
Sourceval of_data_model : GapiJson.json_data_model -> t
OCaml

Innovation. Community. Security.