package gapi-ocaml

  1. Overview
  2. Docs
A simple OCaml client for Google Services

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (2)

Authors

  1. A
    Alessandro Strada

Maintainers

  1. A
    Alessandro Strada <alessandro.strada@gmail.com>

Sources

v0.4.7.tar.gz
sha256=3a9e7ba4446b90f842c10dc2e49211c394c9f012715da01bb0b80baccabb41bb
md5=27919a0188772392e9b74bfd95fbaaa1

doc/gapi-ocaml/GapiPlusV1Service/PeopleResource/index.html

Module GapiPlusV1Service.PeopleResourceSource

Sourcemodule OrderBy : sig ... end
Sourcemodule Collection : sig ... end
Sourceval get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> GapiConversation.Session.t -> GapiPlusV1Model.Person.t * GapiConversation.Session.t

Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/plus/v1/").

  • parameter etag

    Optional ETag.

  • parameter std_params

    Optional standard parameters.

  • parameter userId

    The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user.

Sourceval list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?maxResults:int -> ?orderBy:OrderBy.t -> ?pageToken:string -> userId:string -> collection:Collection.t -> GapiConversation.Session.t -> GapiPlusV1Model.PeopleFeed.t * GapiConversation.Session.t

List all of the people in the specified collection.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/plus/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter maxResults

    The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • parameter orderBy

    The order to return people in.

  • parameter pageToken

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

  • parameter userId

    Get the collection of people for the person identified. Use "me" to indicate the authenticated user.

  • parameter collection

    The collection of people to list.

Sourceval listByActivity : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?maxResults:int -> ?pageToken:string -> activityId:string -> collection:Collection.t -> GapiConversation.Session.t -> GapiPlusV1Model.PeopleFeed.t * GapiConversation.Session.t

List all of the people in the specified collection for a particular activity.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/plus/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter maxResults

    The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • parameter pageToken

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

  • parameter activityId

    The ID of the activity to get the list of people for.

  • parameter collection

    The collection of people to list.

Search all public profiles.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/plus/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter language

    Specify the preferred language to search with. See search language codes for available values.

  • parameter maxResults

    The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • parameter pageToken

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.

  • parameter query

    Specify a query string for full text search of public text in all profiles.