package gapi-ocaml

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

    The subject matter of the content.

    *)
  2. additionalName : string list;
    (*

    An additional name for a Person, can be used for a middle name.

    *)
  3. address : t option;
    (*

    Postal address.

    *)
  4. addressCountry : string;
    (*

    Address country.

    *)
  5. addressLocality : string;
    (*

    Address locality.

    *)
  6. addressRegion : string;
    (*

    Address region.

    *)
  7. associated_media : t list;
    (*

    The encoding.

    *)
  8. attendeeCount : int;
    (*

    Number of attendees.

    *)
  9. attendees : t list;
    (*

    A person attending the event.

    *)
  10. audio : t option;
    (*

    From http://schema.org/MusicRecording, the audio file.

    *)
  11. author : t list;
    (*

    The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.

    *)
  12. bestRating : string;
    (*

    Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.

    *)
  13. birthDate : string;
    (*

    Date of birth.

    *)
  14. byArtist : t option;
    (*

    From http://schema.org/MusicRecording, the artist that performed this recording.

    *)
  15. caption : string;
    (*

    The caption for this object.

    *)
  16. contentSize : string;
    (*

    File size in (mega/kilo) bytes.

    *)
  17. contentUrl : string;
    (*

    Actual bytes of the media object, for example the image file or video file.

    *)
  18. contributor : t list;
    (*

    A list of contributors to this result.

    *)
  19. dateCreated : string;
    (*

    The date the result was created such as the date that a review was first created.

    *)
  20. dateModified : string;
    (*

    The date the result was last modified such as the date that a review was last edited.

    *)
  21. datePublished : string;
    (*

    The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.

    *)
  22. description : string;
    (*

    The string that describes the content of the result.

    *)
  23. duration : string;
    (*

    The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.

    *)
  24. embedUrl : string;
    (*

    A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.

    *)
  25. endDate : string;
    (*

    The end date and time of the event (in ISO 8601 date format).

    *)
  26. familyName : string;
    (*

    Family name. This property can be used with givenName instead of the name property.

    *)
  27. gender : string;
    (*

    Gender of the person.

    *)
  28. geo : t option;
    (*

    Geo coordinates.

    *)
  29. givenName : string;
    (*

    Given name. This property can be used with familyName instead of the name property.

    *)
  30. height : string;
    (*

    The height of the media object.

    *)
  31. id : string;
    (*

    An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.

    *)
  32. image : string;
    (*

    A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.

    *)
  33. inAlbum : t option;
    (*

    From http://schema.org/MusicRecording, which album a song is in.

    *)
  34. kind : string;
    (*

    Identifies this resource as an itemScope.

    *)
  35. latitude : float;
    (*

    Latitude.

    *)
  36. location : t option;
    (*

    The location of the event or organization.

    *)
  37. longitude : float;
    (*

    Longitude.

    *)
  38. name : string;
    (*

    The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."

    *)
  39. partOfTVSeries : t option;
    (*

    Property of http://schema.org/TVEpisode indicating which series the episode belongs to.

    *)
  40. performers : t list;
    (*

    The main performer or performers of the event-for example, a presenter, musician, or actor.

    *)
  41. playerType : string;
    (*

    Player type that is required. For example: Flash or Silverlight.

    *)
  42. postOfficeBoxNumber : string;
    (*

    Post office box number.

    *)
  43. postalCode : string;
    (*

    Postal code.

    *)
  44. ratingValue : string;
    (*

    Rating value.

    *)
  45. reviewRating : t option;
    (*

    Review rating.

    *)
  46. startDate : string;
    (*

    The start date and time of the event (in ISO 8601 date format).

    *)
  47. streetAddress : string;
    (*

    Street address.

    *)
  48. text : string;
    (*

    The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.

    *)
  49. thumbnail : t option;
    (*

    Thumbnail image for an image or video.

    *)
  50. thumbnailUrl : string;
    (*

    A URL to a thumbnail image that represents this result.

    *)
  51. tickerSymbol : string;
    (*

    The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.

    *)
  52. _type : string;
    (*

    The schema.org URL that best describes the referenced object and matches the type of moment.

    *)
  53. url : string;
    (*

    The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.

    *)
  54. width : string;
    (*

    The width of the media object.

    *)
  55. worstRating : string;
    (*

    Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.

    *)
}
val about : (t, t option) GapiLens.t
val additionalName : (t, string list) GapiLens.t
val address : (t, t option) GapiLens.t
val addressCountry : (t, string) GapiLens.t
val addressLocality : (t, string) GapiLens.t
val addressRegion : (t, string) GapiLens.t
val associated_media : (t, t list) GapiLens.t
val attendeeCount : (t, int) GapiLens.t
val attendees : (t, t list) GapiLens.t
val audio : (t, t option) GapiLens.t
val author : (t, t list) GapiLens.t
val bestRating : (t, string) GapiLens.t
val birthDate : (t, string) GapiLens.t
val byArtist : (t, t option) GapiLens.t
val caption : (t, string) GapiLens.t
val contentSize : (t, string) GapiLens.t
val contentUrl : (t, string) GapiLens.t
val contributor : (t, t list) GapiLens.t
val dateCreated : (t, string) GapiLens.t
val dateModified : (t, string) GapiLens.t
val datePublished : (t, string) GapiLens.t
val description : (t, string) GapiLens.t
val duration : (t, string) GapiLens.t
val embedUrl : (t, string) GapiLens.t
val endDate : (t, string) GapiLens.t
val familyName : (t, string) GapiLens.t
val gender : (t, string) GapiLens.t
val geo : (t, t option) GapiLens.t
val givenName : (t, string) GapiLens.t
val height : (t, string) GapiLens.t
val id : (t, string) GapiLens.t
val image : (t, string) GapiLens.t
val inAlbum : (t, t option) GapiLens.t
val kind : (t, string) GapiLens.t
val latitude : (t, float) GapiLens.t
val location : (t, t option) GapiLens.t
val longitude : (t, float) GapiLens.t
val name : (t, string) GapiLens.t
val partOfTVSeries : (t, t option) GapiLens.t
val performers : (t, t list) GapiLens.t
val playerType : (t, string) GapiLens.t
val postOfficeBoxNumber : (t, string) GapiLens.t
val postalCode : (t, string) GapiLens.t
val ratingValue : (t, string) GapiLens.t
val reviewRating : (t, t option) GapiLens.t
val startDate : (t, string) GapiLens.t
val streetAddress : (t, string) GapiLens.t
val text : (t, string) GapiLens.t
val thumbnail : (t, t option) GapiLens.t
val thumbnailUrl : (t, string) GapiLens.t
val tickerSymbol : (t, string) GapiLens.t
val _type : (t, string) GapiLens.t
val url : (t, string) GapiLens.t
val width : (t, string) GapiLens.t
val worstRating : (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
OCaml

Innovation. Community. Security.