package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Urls : sig ... end
module PlacesLived : sig ... end
module Organizations : sig ... end
module Name : sig ... end
module Image : sig ... end
module Emails : sig ... end
module Cover : sig ... end
module AgeRange : sig ... end
type t = {
  1. aboutMe : string;
    (*

    A short biography for this person.

    *)
  2. ageRange : AgeRange.t;
    (*

    The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.

    *)
  3. birthday : string;
    (*

    The person's date of birth, represented as YYYY-MM-DD.

    *)
  4. braggingRights : string;
    (*

    The "bragging rights" line of this person.

    *)
  5. circledByCount : int;
    (*

    For followers who are visible, the number of people who have added this person or page to a circle.

    *)
  6. cover : Cover.t;
    (*

    The cover photo content.

    *)
  7. currentLocation : string;
    (*

    (this field is not currently used)

    *)
  8. displayName : string;
    (*

    The name of this person, which is suitable for display.

    *)
  9. domain : string;
    (*

    The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.

    *)
  10. emails : Emails.t list;
    (*

    A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.

    *)
  11. etag : string;
    (*

    ETag of this response for caching purposes.

    *)
  12. gender : string;
    (*

    The person's gender. Possible values include, but are not limited to, the following values:

    • "male" - Male gender.
    • "female" - Female gender.
    • "other" - Other.
    *)
  13. id : string;
    (*

    The ID of this person.

    *)
  14. image : Image.t;
    (*

    The representation of the person's profile photo.

    *)
  15. isPlusUser : bool;
    (*

    Whether this user has signed up for Google+.

    *)
  16. kind : string;
    (*

    Identifies this resource as a person. Value: "plus#person".

    *)
  17. language : string;
    (*

    The user's preferred language for rendering.

    *)
  18. name : Name.t;
    (*

    An object representation of the individual components of a person's name.

    *)
  19. nickname : string;
    (*

    The nickname of this person.

    *)
  20. objectType : string;
    (*

    Type of person within Google+. Possible values include, but are not limited to, the following values:

    • "person" - represents an actual person.
    • "page" - represents a page.
    *)
  21. occupation : string;
    (*

    The occupation of this person.

    *)
  22. organizations : Organizations.t list;
    (*

    A list of current or past organizations with which this person is associated.

    *)
  23. placesLived : PlacesLived.t list;
    (*

    A list of places where this person has lived.

    *)
  24. plusOneCount : int;
    (*

    If a Google+ Page, the number of people who have +1'd this page.

    *)
  25. relationshipStatus : string;
    (*

    The person's relationship status. Possible values include, but are not limited to, the following values:

    • "single" - Person is single.
    • "in_a_relationship" - Person is in a relationship.
    • "engaged" - Person is engaged.
    • "married" - Person is married.
    • "its_complicated" - The relationship is complicated.
    • "open_relationship" - Person is in an open relationship.
    • "widowed" - Person is widowed.
    • "in_domestic_partnership" - Person is in a domestic partnership.
    • "in_civil_union" - Person is in a civil union.
    *)
  26. skills : string;
    (*

    The person's skills.

    *)
  27. tagline : string;
    (*

    The brief description (tagline) of this person.

    *)
  28. url : string;
    (*

    The URL of this person's profile.

    *)
  29. urls : Urls.t list;
    (*

    A list of URLs for this person.

    *)
  30. verified : bool;
    (*

    Whether the person or Google+ Page has been verified.

    *)
}
val aboutMe : (t, string) GapiLens.t
val ageRange : (t, AgeRange.t) GapiLens.t
val birthday : (t, string) GapiLens.t
val braggingRights : (t, string) GapiLens.t
val circledByCount : (t, int) GapiLens.t
val cover : (t, Cover.t) GapiLens.t
val currentLocation : (t, string) GapiLens.t
val displayName : (t, string) GapiLens.t
val domain : (t, string) GapiLens.t
val emails : (t, Emails.t list) GapiLens.t
val etag : (t, string) GapiLens.t
val gender : (t, string) GapiLens.t
val id : (t, string) GapiLens.t
val image : (t, Image.t) GapiLens.t
val isPlusUser : (t, bool) GapiLens.t
val kind : (t, string) GapiLens.t
val language : (t, string) GapiLens.t
val name : (t, Name.t) GapiLens.t
val nickname : (t, string) GapiLens.t
val objectType : (t, string) GapiLens.t
val occupation : (t, string) GapiLens.t
val organizations : (t, Organizations.t list) GapiLens.t
val placesLived : (t, PlacesLived.t list) GapiLens.t
val plusOneCount : (t, int) GapiLens.t
val relationshipStatus : (t, string) GapiLens.t
val skills : (t, string) GapiLens.t
val tagline : (t, string) GapiLens.t
val url : (t, string) GapiLens.t
val urls : (t, Urls.t list) GapiLens.t
val verified : (t, bool) 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